diff --git a/docs/.vuepress/utils/customTypeJson.json b/docs/.vuepress/utils/customTypeJson.json index b80a48e1635b0fdf77a550ce964996529cec4ac4..1f4eded6193ddb29524d01418da333e8b7d55d59 100644 --- a/docs/.vuepress/utils/customTypeJson.json +++ b/docs/.vuepress/utils/customTypeJson.json @@ -1 +1 @@ -{"Event":{"name":"## Event","description":"","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件的名称 |\n\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件的名称 |\n| eventInit | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | - | 事件初始参数。支持字段：`bubbles`表明该事件是否冒泡。可选，默认为false；`cancelable`表明该事件是否可以被取消。可选，默认为false。 |\n\n### Event 的属性值 @event-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"\n阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"\n阻止当前事件的默认行为\n","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### Event 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UTSJSONObject":{"name":"## UTSJSONObject","description":"","extends":"","param":"","methods":{"get":{"name":"#### get(key) @get","description":"\n获取一个 属性，返回类型是any 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| any \\| null | 否 |\n \n","compatibility":"##### get 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#get)\n"},"set":{"name":"#### set(key, value) @set","description":"\n获取一个 属性，返回类型是any 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - |\n| value | any | 是 | - | - | - | \n","returnValue":"","compatibility":"##### set 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#set)\n"},"getAny":{"name":"#### getAny(key) @getany","description":"\n获取一个 属性，返回类型是any 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| any \\| null | 否 |\n \n","compatibility":"##### getAny 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getAny)\n"},"getBoolean":{"name":"#### getBoolean(key) @getboolean","description":"\n获取一个Boolean属性，返回类型是Boolean 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| boolean \\| null | 否 |\n \n","compatibility":"##### getBoolean 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getBoolean)\n"},"getNumber":{"name":"#### getNumber(key) @getnumber","description":"\n获取一个number属性，返回类型是number 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| number \\| null | 否 |\n \n","compatibility":"##### getNumber 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getNumber)\n"},"getString":{"name":"#### getString(key) @getstring","description":"\n获取一个string属性，返回类型是string 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| string \\| null | 否 |\n \n","compatibility":"##### getString 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getString)\n"},"getJSON":{"name":"#### getJSON(key) @getjson","description":"\n获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \\| null | 否 |\n \n","compatibility":"##### getJSON 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getJSON)\n"},"getArray":{"name":"#### getArray(key) @getarray","description":"\n获取一个Array属性，返回类型是Array 或者 null, 数组元素类型由泛型T决定","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| T[] \\| null | 否 |\n \n","compatibility":"##### getArray 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getArray)\n"},"toMap":{"name":"#### toMap() @tomap","description":"\n将当前 UTSJSONObject 实例转换为 Map 实例。","param":"","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| Map\\ |\n \n","compatibility":"##### toMap 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#toMap)\n"}},"compatibility":"### UTSJSONObject 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UniElement":{"name":"## UniElement","description":"\nUVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。","extends":"","param":"\n### UniElement 的属性值 @unielement-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| classList | Array\\ | 是 | - | - | 只读属性 获取当前元素的的 class 属性的动态集合。 |\n| firstChild | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| lastChild | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| parentElement | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| previousSibling | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| nextElementSibling | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| children | Array\\<[UniElement](/dom/unielement.md)\\> | 是 | - | - | 只读属性 获取当前元素包含的子元素的集合 |\n| tagName | string | 是 | - | - | 只读属性 获取当前元素的标签名 |\n| nodeName | string | 是 | - | - | 只读属性 获取当前元素的元素名称 |\n| dataset | Map\\ | 是 | - | - | 只读属性 获取元素上自定义数据属性（data-*）的集合 |\n| attributes | Map\\ | 是 | - | - | 只读属性 获取元素上所有属性元素的集合 |\n| style | [CSSStyleDeclaration](/dom/cssstyledeclaration.md) | 是 | - | - | 只读属性 获取元素的CSS样式对象 |\n| scrollWidth | number | 是 | - | - | 只读属性 获取可滚动元素内容的总宽度，仅scroll-view、list-view组件支持，其他组件返回视图宽度 |\n| scrollHeight | number | 是 | - | - | 只读属性 获取可滚动元素内容的总高度，仅scroll-view、list-view组件支持，其他组件返回视图高度 |\n| scrollLeft | number | 是 | - | - | 获取或修改元素滚动条到元素左边的距离像素数，仅scroll-view、list-view组件支持。其他组件返回0 |\n| scrollTop | number | 是 | - | - | 获取或修改元素滚动条到元素顶部的距离像素数，仅scroll-view、list-view组件支持。其他组件返回0 |\n| offsetLeft | number | 是 | - | - | 只读属性 元素的左边界偏移值 单位px |\n| offsetTop | number | 是 | - | - | 只读属性 元素的顶部边界偏移值 单位px |\n| offsetWidth | number | 是 | - | - | 只读属性 元素的布局宽度，宽度包含border、padding的数据值 单位px |\n| offsetHeight | number | 是 | - | - | 只读属性 元素的布局高度，高度包含border、padding的数据值 单位px |\n| ext | Map\\ | 是 | - | - | 只读属性 扩展属性 |\n","methods":{"takeSnapshot":{"name":"#### takeSnapshot(options) @takesnapshot","description":"\n对当前组件进行截图，调用此方法会将当前组件（包含子节点）渲染结果导出成图片。\n成功会返回图片对应的临时文件路径，目前默认png格式\n","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [TakeSnapshotOptions](#takesnapshotoptions-values) | 是 | - | - | 组件截图的参数对象 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| type | string \\| null | 否 | \"file\" | - | 截图导出类型，目前仅支持 'file' 保存到临时文件目录 |\n@| format | string \\| null | 否 | \"png\" | - | 截图文件格式，目前仅支持 'png' |\n@| success | (res: [TakeSnapshotSuccess](#takesnapshotsuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (res: [TakeSnapshotFail](#takesnapshotfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### TakeSnapshotSuccess 的属性值 @takesnapshotsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tempFilePath | string | 是 | - | - | 截图保存的临时文件路径 |\n\n##### TakeSnapshotFail 的属性值 @takesnapshotfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"##### takeSnapshot 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.93 | 4.11 | x |\n","tutorial":""},"appendChild":{"name":"#### appendChild(aChild) @appendchild","description":"\n将一个元素添加到指定父元素的子元素列表的末尾处。如果将被插入的元素已经存在于当前文档的文档树中，那么将会它从原先的位置移动到新的位置。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| aChild | [UniElement](/dom/unielement.md) | 是 | - | - | 插入子元素对象 | \n","returnValue":"","compatibility":"##### appendChild 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"insertBefore":{"name":"#### insertBefore(newChild, refChild?) @insertbefore","description":"\n在参考元素之前插入一个拥有指定父元素的子元素。如果给定的子元素是对文档中现有元素的引用，insertBefore() 会将其从当前位置移动到新位置。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| newChild | [UniElement](/dom/unielement.md) | 是 | - | - | 插入子元素对象 |\n| refChild | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UniElement](/dom/unielement.md) \\| null | 否 |\n \n","compatibility":"##### insertBefore 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"setAttribute":{"name":"#### setAttribute(key, value) @setattribute","description":"\n设置指定元素上的某个属性值。如果设置的属性已经存在，则更新该属性值；否则使用指定的名称和值添加一个新的属性。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 属性名称 |\n| value | string | 是 | - | - | 属性值域 | \n","returnValue":"","compatibility":"##### setAttribute 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"getAttribute":{"name":"#### getAttribute(key) @getattribute","description":"\n获取元素指定的属性值，如果指定的属性不存在则返回null。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 属性名称 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| string \\| null | 否 |\n \n","compatibility":"##### getAttribute 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"hasAttribute":{"name":"#### hasAttribute(key) @hasattribute","description":"\n返回改元素是否包含有指定的属性，属性存在则返回true，否则返回false。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 属性名称 | \n","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n","compatibility":"##### hasAttribute 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"removeAttribute":{"name":"#### removeAttribute(key) @removeattribute","description":"\n从元素中删除一个属性，如果指定的属性不存在，则不做任何操作，也不会产生错误。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 属性名称 | \n","returnValue":"","compatibility":"##### removeAttribute 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"getBoundingClientRect":{"name":"#### getBoundingClientRect() @getboundingclientrect","description":"\n获取元素的大小及其相对于窗口的位置信息。","param":"","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| [DOMRect](/dom/domrect.md) |\n \n","compatibility":"##### getBoundingClientRect 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"getDrawableContext":{"name":"#### getDrawableContext() @getdrawablecontext","description":"\n获取组件的绘制对象，仅uvue页面中的 view 组件支持，其它组件不支持则返回null。","param":"","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [DrawableContext](/dom/drawablecontext.md) \\| null | 否 |\n \n","compatibility":"##### getDrawableContext 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | x |\n","tutorial":""},"addEventListener":{"name":"#### addEventListener(type, callback) @addeventlistener","description":"\n将指定的监听器注册到元素对象上，当该对象触发指定的事件时，指定的回调函数就会被执行。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件类型 |\n| callback | (event: T) => R | 是 | - | - | 事件监听器 T表示event类型，R表示返回值类型 | \n","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| UniCallbackWrapper |\n \n","compatibility":"##### addEventListener 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"removeEventListener":{"name":"#### removeEventListener(type, callbackWrapper) @removeeventlistener","description":"\n删除使用 addEventListener 方法添加的事件监听器。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件类型 |\n| callbackWrapper | UniCallbackWrapper | 是 | - | - | 事件监听回调封装类 | \n","returnValue":"","compatibility":"##### removeEventListener 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"removeChild":{"name":"#### removeChild(aChild) @removechild","description":"\n从元素中删除一个子元素，返回删除的元素。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| aChild | [UniElement](/dom/unielement.md) | 是 | - | - | 被删除子元素对象 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UniElement](/dom/unielement.md) \\| null | 否 |\n \n","compatibility":"##### removeChild 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"remove":{"name":"#### remove() @remove","description":"\n把元素对象从它所属的 DOM 树中删除。","param":"","returnValue":"","compatibility":"##### remove 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"dispatchEvent":{"name":"#### dispatchEvent(type, value) @dispatchevent","description":"\n向一个指定的事件目标派发一个 Event，并以合适的顺序（同步地）调用此事件的监听器回调函数。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件类型 |\n| value | [UniEvent](/component/common#unievent) | 是 | - | - | 事件返回对象 | \n","returnValue":"","compatibility":"##### dispatchEvent 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"scrollTo":{"name":"#### scrollTo(x, y) @scrollto","description":"\n使界面滚动到给定元素的指定坐标位置 仅scroll-view、list-view组件支持","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | x轴要滚动到坐标位置(单位px) |\n| y | number | 是 | - | - | y轴要滚动到坐标位置(单位px) | \n","returnValue":"","compatibility":"##### scrollTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"scrollBy":{"name":"#### scrollBy(x, y) @scrollby","description":"\n使得元素滚动一段特定距离 仅scroll-view、list-view组件支持","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | x轴要滚动的距离(单位px) |\n| y | number | 是 | - | - | y轴要滚动的距离(单位px) | \n","returnValue":"","compatibility":"##### scrollBy 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"querySelector":{"name":"#### querySelector(selector) @queryselector","description":"\n返回文档中与指定选择器或选择器组匹配的第一个 Element对象。如果找不到匹配项，则返回null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| selector | [string.cssSelectorString](/uts/data-type.md#ide-string) | 是 | - | - | CSS 选择器字符串 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UniElement](/dom/unielement.md) \\| null | 否 |\n \n","compatibility":"##### querySelector 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"querySelectorAll":{"name":"#### querySelectorAll(selector) @queryselectorall","description":"\n返回与指定的选择器组匹配的文档中的元素列表","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| selector | [string.cssSelectorString](/uts/data-type.md#ide-string) | 是 | - | - | CSS 选择器字符串 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Array\\<[UniElement](/dom/unielement.md)\\> \\| null | 否 |\n \n","compatibility":"##### querySelectorAll 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"focus":{"name":"#### focus() @focus","description":"\n使元素获取焦点 仅input、Textarea组件支持","param":"","returnValue":"","compatibility":"##### focus 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"blur":{"name":"#### blur() @blur","description":"\n使元素丢失焦点 仅input、Textarea组件支持","param":"","returnValue":"","compatibility":"##### blur 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""}},"compatibility":"### UniElement 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"CSSStyleDeclaration":{"name":"## CSSStyleDeclaration","description":"\nCSSStyleDeclaration表示一个CSS 声明块对象，它是一个 CSS 属性键值对的集合，暴露样式信息和各种与样式相关的方法和属性。","extends":"","param":"","methods":{"setProperty":{"name":"#### setProperty(name, value?) @setproperty","description":"\n对CSS指定样式设置一个新值，如有此样式已存在则更新。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string ([string.cssPropertyString](/uts/data-type.md#ide-string)) | 是 | - | - | CSS样式名称 |\n| value | any \\| null | 否 | - | - | 要设置的新CSS样式值 | \n","returnValue":"","compatibility":"##### setProperty 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"getPropertyValue":{"name":"#### getPropertyValue(property) @getpropertyvalue","description":"\n获取CSS指定的样式值，如果指定的样式不存在则返回null。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| property | string ([string.cssPropertyString](/uts/data-type.md#ide-string)) | 是 | - | - | 要获取的CSS样式名称 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| any \\| null | 否 |\n \n","compatibility":"##### getPropertyValue 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"removeProperty":{"name":"#### removeProperty(property) @removeproperty","description":"\n删除CSS指定的样式值","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| property | string ([string.cssPropertyString](/uts/data-type.md#ide-string)) | 是 | - | - | 要删除的CSS样式名称 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| any \\| null | 否 |\n \n","compatibility":"##### removeProperty 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""}},"compatibility":"### CSSStyleDeclaration 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"TakeSnapshotOptions":{"name":"## TakeSnapshotOptions","description":"\n组件截图的参数配置选项","extends":"","param":"\n### TakeSnapshotOptions 的属性值 @takesnapshotoptions-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string \\| null | 否 | \"file\" | - | 截图导出类型，目前仅支持 'file' 保存到临时文件目录 |\n| format | string \\| null | 否 | \"png\" | - | 截图文件格式，目前仅支持 'png' |\n| success | (res: **TakeSnapshotSuccess**) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| tempFilePath | string | 是 | - | - | 截图保存的临时文件路径 |\n| fail | (res: **TakeSnapshotFail**) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| errMsg | string | 是 | - | - | - |\n| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","compatibility":"### TakeSnapshotOptions 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"TakeSnapshotSuccessCallback":{"name":"## TakeSnapshotSuccessCallback","description":"","extends":"","param":"","compatibility":"### TakeSnapshotSuccessCallback 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"TakeSnapshotSuccess":{"name":"## TakeSnapshotSuccess","description":"","extends":"","param":"\n### TakeSnapshotSuccess 的属性值 @takesnapshotsuccess-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tempFilePath | string | 是 | - | - | 截图保存的临时文件路径 |\n","compatibility":"### TakeSnapshotSuccess 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"TakeSnapshotFailCallback":{"name":"## TakeSnapshotFailCallback","description":"","extends":"","param":"","compatibility":"### TakeSnapshotFailCallback 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"TakeSnapshotFail":{"name":"## TakeSnapshotFail","description":"","extends":"","param":"\n### TakeSnapshotFail 的属性值 @takesnapshotfail-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","compatibility":"### TakeSnapshotFail 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"TakeSnapshotCompleteCallback":{"name":"## TakeSnapshotCompleteCallback","description":"","extends":"","param":"","compatibility":"### TakeSnapshotCompleteCallback 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"DOMRect":{"name":"## DOMRect","description":"\n一个 DOMRect 代表一个矩形。","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 否 | 0 | - | 矩形原点的x坐标 |\n| y | number | 否 | 0 | - | 矩形原点的y坐标 |\n| width | number | 否 | 0 | - | 矩形的宽 |\n| height | number | 否 | 0 | - | 矩形的高 |\n\n### DOMRect 的属性值 @domrect-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| width | number | 是 | - | - | 矩形的宽 |\n| height | number | 是 | - | - | 矩形的高 |\n| x | number | 是 | - | - | 矩形原点的x坐标 |\n| y | number | 是 | - | - | 矩形原点的y坐标 |\n| left | number | 是 | - | - | 矩形的左坐标值 |\n| right | number | 是 | - | - | 矩形的右坐标值 |\n| top | number | 是 | - | - | 矩形的顶坐标值 |\n| bottom | number | 是 | - | - | 矩形的底坐标值 |\n","compatibility":"### DOMRect 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"DrawableContext":{"name":"## DrawableContext","description":"","extends":"","param":"\n### DrawableContext 的属性值 @drawablecontext-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| font | string | 是 | 10px | - | 设置字体大小 |\n| fillStyle | [string.ColorString](/uts/data-type.md#ide-string) | 是 | #000 (黑色) | - | 设置填充颜色 |\n| lineCap | string | 是 | butt | - | 指定如何绘制每一条线条末端的属性，可选值：`butt`线段末端以方形结束；`round`线段末端以圆形结束；`square`线段末端以方形结束，但是会增加一个一半宽度的矩形区域。 |\n| lineDashOffset | number | 是 | - | - | 设置虚线偏移量 |\n| lineJoin | string | 是 | miter | - | 设置 2 个长度不为 0 的线条相连部分如何连接在一起的属性，可选值：`bevel`斜角；`round`圆角；`miter`尖角。 |\n| lineWidth | number | 是 | 1px | - | 设置线条的宽度 |\n| strokeStyle | [string.ColorString](/uts/data-type.md#ide-string) | 是 | #000 (黑色) | - | 设置边框的颜色 |\n| textAlign | string | 是 | left | - | 设置文本的对齐方式，可取值：`left`左对齐；`center`居中对齐；`right`右对齐。 |\n","methods":{"beginPath":{"name":"#### beginPath() @beginpath","description":"\n创建一个新的空路径","param":"","returnValue":"","compatibility":"##### beginPath 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"arc":{"name":"#### arc(x, y, radius, startAngle, endAngle, anticlockwise?) @arc","description":"\n绘制一段弧线","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 圆心的X轴坐标 |\n| y | number | 是 | - | - | 圆心的Y轴坐标 |\n| radius | number | 是 | - | - | 圆弧的半径 |\n| startAngle | number | 是 | - | - | 圆弧的起始点，x 轴方向开始计算，单位为弧度 |\n| endAngle | number | 是 | - | - | 圆弧的终点，单位为弧度 |\n| anticlockwise | boolean \\| null | 否 | true | - | 圆弧绘制方向，true：逆时针绘制，false：顺时针绘制。 | \n","returnValue":"","compatibility":"##### arc 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"moveTo":{"name":"#### moveTo(x, y) @moveto","description":"\n将一个新的路径的起始点移动到 (x，y) 坐标","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 点的X轴坐标 |\n| y | number | 是 | - | - | 点的Y轴坐标 | \n","returnValue":"","compatibility":"##### moveTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"rect":{"name":"#### rect(x, y, width, height) @rect","description":"\n创建一个矩形路径","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 矩形起点的X轴坐标 |\n| y | number | 是 | - | - | 矩形起点的Y轴坐标 |\n| width | number | 是 | - | - | 矩形宽度 |\n| height | number | 是 | - | - | 矩形高度 | \n","returnValue":"","compatibility":"##### rect 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"lineTo":{"name":"#### lineTo(x, y) @lineto","description":"\n将路径的最后一个点连接到 (x，y) 坐标","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 线终点的X轴坐标 |\n| y | number | 是 | - | - | 线终点的Y轴坐标 | \n","returnValue":"","compatibility":"##### lineTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"closePath":{"name":"#### closePath() @closepath","description":"\n闭合路径，将最后一个点与起点连接起来。如果图形已经封闭，或者只有一个点，那么此方法不会产生任何效果。","param":"","returnValue":"","compatibility":"##### closePath 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"stroke":{"name":"#### stroke() @stroke","description":"\n绘制当前或已经存在的路径的边框。","param":"","returnValue":"","compatibility":"##### stroke 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"strokeRect":{"name":"#### strokeRect(x, y, width, height) @strokerect","description":"\n绘制一个矩形框","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 矩形起点的X轴坐标 |\n| y | number | 是 | - | - | 矩形起点的Y轴坐标 |\n| width | number | 是 | - | - | 矩形宽度 |\n| height | number | 是 | - | - | 矩形高度 | \n","returnValue":"","compatibility":"##### strokeRect 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"strokeText":{"name":"#### strokeText(text, x, y) @stroketext","description":"\n绘制空心字符","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| text | string | 是 | - | - | 要绘制的字符 |\n| x | number | 是 | - | - | 字符开始绘制的X轴坐标 |\n| y | number | 是 | - | - | 字符开始绘制的Y轴坐标 | \n","returnValue":"","compatibility":"##### strokeText 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"fill":{"name":"#### fill(fillRule?) @fill","description":"\n填充当前或已存在的路径","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| fillRule | string \\| null | 否 | nonzero | - | 填充规则。可取值：`nonzero`非零环绕规则；`evenodd`奇偶环绕规则。 | \n","returnValue":"","compatibility":"##### fill 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"fillRect":{"name":"#### fillRect(x, y, width, height) @fillrect","description":"\n绘制一个实心矩形","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 矩形起点的X轴坐标 |\n| y | number | 是 | - | - | 矩形起点的Y轴坐标 |\n| width | number | 是 | - | - | 矩形宽度 |\n| height | number | 是 | - | - | 矩形高度 | \n","returnValue":"","compatibility":"##### fillRect 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"fillText":{"name":"#### fillText(text, x, y) @filltext","description":"\n绘制实心字符","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| text | string | 是 | - | - | 要绘制的字符 |\n| x | number | 是 | - | - | 字符开始绘制的X轴坐标 |\n| y | number | 是 | - | - | 字符开始绘制的Y轴坐标 | \n","returnValue":"","compatibility":"##### fillText 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"reset":{"name":"#### reset() @reset","description":"\n清空绘制数据","param":"","returnValue":"","compatibility":"##### reset 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"update":{"name":"#### update() @update","description":"\n将所有绘制内容更新到画布上","param":"","returnValue":"","compatibility":"##### update 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"setLineDash":{"name":"#### setLineDash(segments) @setlinedash","description":"\n设置虚线样式","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| segments | number[\\] | 是 | - | - | 一组描述交替绘制线段和间距长度的数字。 | \n","returnValue":"","compatibility":"##### setLineDash 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"bezierCurveTo":{"name":"#### bezierCurveTo(cp1x, cp1y, cp2x, cp2y, x, y) @beziercurveto","description":"\n创建三次方贝塞尔曲线路径","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| cp1x | number | 是 | - | - | 第一个贝塞尔控制点的 x 坐标 |\n| cp1y | number | 是 | - | - | 第一个贝塞尔控制点的 y 坐标 |\n| cp2x | number | 是 | - | - | 第二个贝塞尔控制点的 x 坐标 |\n| cp2y | number | 是 | - | - | 第二个贝塞尔控制点的 y 坐标 |\n| x | number | 是 | - | - | 结束点的 x 坐标 |\n| y | number | 是 | - | - | 结束点的 y 坐标 | \n","returnValue":"","compatibility":"##### bezierCurveTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""}},"compatibility":"### DrawableContext 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/element-draw/element-draw.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/element-draw/element-draw\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n var y = 160\n export default {\n data() {\n return {\n texts: [\n 'HBuilderX，轻巧、极速，极客编辑器',\n 'uni-app x，终极跨平台方案',\n 'uniCloud，js serverless云服务',\n 'uts，大一统语言',\n 'uniMPSdk，让你的App具备小程序能力',\n 'uni-admin，开源、现成的全端管理后台',\n 'uni-id，开源、全端的账户中心',\n 'uni-pay，开源、云端一体、全平台的支付',\n 'uni-ai，聚合ai能力',\n 'uni-cms，开源、云端一体、全平台的内容管理平台',\n 'uni-im，开源、云端一体、全平台的im即时消息',\n 'uni统计，开源、完善、全平台的统计报表',\n '......'\n ] as string[]\n }\n },\n onShow() {\n },\n\n onReady() {\n this.drawText()\n this.drawLines()\n this.drawCircles()\n this.drawStar()\n this.drawhouse()\n this.drawPoint()\n this.drawRect()\n this.drawArcTo()\n },\n onUnload() {\n y = 160\n },\n methods: {\n drawText() {\n let element = uni.getElementById('draw-text-view')!\n let ctx = element.getDrawableContext()!\n let width = element.getBoundingClientRect().width\n ctx.reset()\n ctx.font = \"15px Arial\"\n ctx.textAlign = \"center\"\n for (var i = 0; i < this.texts.length; i++) {\n let value = this.texts[i]\n if (i % 2 == 0) {\n ctx.fillText(value, width / 2, (20 * (i + 1)))\n } else {\n ctx.lineWidth = 0.5\n ctx.strokeText(value, width / 2, (20 * (i + 1)))\n }\n }\n ctx.update()\n },\n drawLines() {\n let ctx = uni.getElementById('draw-line-view')!.getDrawableContext()!\n ctx.reset()\n ctx.lineWidth = 10;\n\n [\"round\", \"bevel\", \"miter\"].forEach((join, i) => {\n ctx.lineJoin = join;\n ctx.beginPath();\n ctx.moveTo(5, 10 + i * 40);\n ctx.lineTo(50, 50 + i * 40);\n ctx.lineTo(90, 10 + i * 40);\n ctx.lineTo(130, 50 + i * 40);\n ctx.lineTo(170, 10 + i * 40);\n ctx.stroke();\n });\n ctx.lineWidth = 1\n var space = 170\n ctx.strokeStyle = '#09f';\n ctx.beginPath();\n ctx.moveTo(10 + space, 10);\n ctx.lineTo(140 + space, 10);\n ctx.moveTo(10 + space, 140);\n ctx.lineTo(140 + space, 140);\n ctx.stroke();\n // Draw lines\n ctx.strokeStyle = 'black';\n ['butt', 'round', 'square'].forEach((lineCap, i) => {\n ctx.lineWidth = 15;\n ctx.lineCap = lineCap;\n ctx.beginPath();\n ctx.moveTo(25 + space + i * 50, 10);\n ctx.lineTo(25 + space + i * 50, 140);\n ctx.stroke();\n });\n ctx.lineWidth = 1;\n this.drawDashedLine([], ctx);\n this.drawDashedLine([2, 2], ctx);\n this.drawDashedLine([10, 10], ctx);\n this.drawDashedLine([20, 5], ctx);\n this.drawDashedLine([15, 3, 3, 3], ctx);\n this.drawDashedLine([20, 3, 3, 3, 3, 3, 3, 3], ctx);\n ctx.lineDashOffset = 18;\n this.drawDashedLine([12, 3, 3], ctx);\n ctx.lineDashOffset = 0\n ctx.setLineDash([0])\n ctx.update()\n },\n drawDashedLine(pattern : Array, ctx : DrawableContext) {\n ctx.beginPath();\n ctx.setLineDash(pattern);\n ctx.moveTo(0, y);\n ctx.lineTo(300, y);\n ctx.stroke();\n y += 15;\n },\n drawCircles() {\n let ctx = uni.getElementById('draw-circle-view')!.getDrawableContext()!\n ctx.reset()\n // Draw shapes\n for (var i = 0; i < 4; i++) {\n for (var j = 0; j < 3; j++) {\n ctx.beginPath();\n var x = 25 + j * 50; // x coordinate\n var y = 25 + i * 50; // y coordinate\n var radius = 20; // Arc radius\n var startAngle = 0; // Starting point on circle\n var endAngle = Math.PI + (Math.PI * j) / 2; // End point on circle\n var clockwise = i % 2 == 0 ? false : true; // clockwise or anticlockwise\n\n ctx.arc(x, y, radius, startAngle, endAngle, clockwise);\n\n if (i > 1) {\n ctx.fill();\n } else {\n ctx.stroke();\n }\n }\n }\n ctx.update()\n },\n\n drawStar() {\n let ctx = uni.getElementById('draw-dash-line')!.getDrawableContext()!\n ctx.reset()\n ctx.beginPath();\n var horn = 5; // 画5个角\n var angle = 360 / horn; // 五个角的度数\n // 两个圆的半径\n var R = 50;\n var r = 20;\n // 坐标\n var x = 100;\n var y = 100;\n for (var i = 0; i < horn; i++) {\n // 角度转弧度：角度/180*Math.PI\n // 外圆顶点坐标\n ctx.lineTo(Math.cos((18 + i * angle) / 180.0 * Math.PI) * R + x, -Math.sin((18 + i * angle) / 180.0 * Math.PI) * R + y);\n // 內圆顶点坐标\n ctx.lineTo(Math.cos((54 + i * angle) / 180.0 * Math.PI) * r + x, -Math.sin((54 + i * angle) / 180.0 * Math.PI) * r + y);\n }\n // closePath：关闭路径，将路径的终点与起点相连\n ctx.closePath();\n ctx.lineWidth = 3;\n ctx.fillStyle = '#E4EF00';\n ctx.strokeStyle = \"red\";\n ctx.fill();\n ctx.stroke();\n\n ctx.lineWidth = 10;\n ctx.beginPath()\n ctx.moveTo(170, 100)\n ctx.lineTo(255, 15)\n ctx.lineTo(340, 100)\n ctx.closePath()\n ctx.fill()\n ctx.strokeStyle = \"blue\"\n ctx.stroke()\n ctx.beginPath()\n ctx.moveTo(170, 145)\n ctx.lineTo(255, 45)\n ctx.lineTo(340, 145)\n ctx.closePath()\n ctx.fill()\n ctx.strokeStyle = \"gray\"\n ctx.stroke()\n // 未设置beginPath，导致上下表现一致，与前端一致\n ctx.moveTo(170, 190)\n ctx.lineTo(255, 90)\n ctx.lineTo(340, 190)\n ctx.closePath()\n ctx.fillStyle = \"orange\"\n ctx.fill()\n ctx.strokeStyle = \"khaki\"\n ctx.stroke()\n ctx.update()\n },\n hex(num : number) : string {\n if (num == 0) {\n return \"00\"\n }\n let hexChars = \"0123456789ABCDEF\";\n let result = \"\";\n while (num > 0) {\n let remainder = Math.floor(num) % 16;\n result = hexChars[remainder] + result;\n num = Math.floor(Math.floor(num) / 16);\n }\n if (result.length == 1) {\n return \"0\" + result\n }\n return result\n },\n drawhouse() {\n let ctx = uni.getElementById('draw-house')!.getDrawableContext()!\n ctx.reset()\n ctx.lineWidth = 10;\n\n // Wall\n ctx.strokeRect(75, 140, 150, 110);\n\n // Door\n ctx.fillRect(130, 190, 40, 60);\n\n // Roof\n ctx.beginPath();\n ctx.moveTo(50, 140);\n ctx.lineTo(150, 60);\n ctx.lineTo(250, 140);\n ctx.closePath();\n ctx.stroke();\n ctx.update()\n },\n drawPoint() {\n let ctx = uni.getElementById('draw-style')!.getDrawableContext()!\n ctx.reset()\n for (let i = 0; i < 6; i++) {\n for (let j = 0; j < 6; j++) {\n ctx.strokeStyle = `rgb(0,${Math.floor(255 - 42.5 * i)},${Math.floor(255 - 42.5 * j)})`;\n ctx.beginPath();\n ctx.arc(12.5 + j * 25, 12.5 + i * 25, 10, 0, Math.PI * 2, true);\n ctx.stroke();\n }\n }\n for (let i = 0; i < 6; i++) {\n for (let j = 0; j < 6; j++) {\n ctx.fillStyle = `rgb(${Math.floor(255 - 42.5 * i)},${Math.floor(255 - 42.5 * j)},0)`;\n ctx.fillRect(180 + j * 25, i * 25, 25, 25);\n }\n }\n ctx.update()\n },\n drawRect() {\n let ctx = uni.getElementById('draw-odd')!.getDrawableContext()!\n ctx.reset()\n // Create path\n ctx.moveTo(30, 90);\n ctx.lineTo(110, 20);\n ctx.lineTo(240, 130);\n ctx.lineTo(60, 130);\n ctx.lineTo(190, 20);\n ctx.lineTo(270, 90);\n ctx.closePath();\n\n // Fill path\n ctx.fillStyle = \"green\";\n ctx.fill(\"evenodd\");\n ctx.update()\n\n },\n drawArcTo() {\n let ctx = uni.getElementById('draw-arcto')!.getDrawableContext()!\n ctx.reset()\n ctx.beginPath();\n ctx.moveTo(50, 20);\n ctx.bezierCurveTo(230, 30, 150, 60, 50, 100);\n ctx.stroke();\n\n ctx.fillStyle = \"blue\";\n // start point\n ctx.fillRect(50, 20, 10, 10);\n // end point\n ctx.fillRect(50, 100, 10, 10);\n\n ctx.fillStyle = \"red\";\n // control point one\n ctx.fillRect(230, 30, 10, 10);\n // control point two\n ctx.fillRect(150, 70, 10, 10);\n ctx.update()\n }\n }\n }\n\n```\n:::"},"UniCallbackWrapper":{"name":"## UniCallbackWrapper","description":"\n事件回调封装类，用于注销监听函数的形参","extends":"","param":"","compatibility":"### UniCallbackWrapper 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UniEvent":{"name":"## UniEvent","description":"","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件的名称 |\n\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件的名称 |\n| eventInit | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | - | 事件初始参数。支持字段：`bubbles`表明该事件是否冒泡。可选，默认为false；`cancelable`表明该事件是否可以被取消。可选，默认为false。 |\n\n### UniEvent 的属性值 @unievent-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"\n阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"\n阻止当前事件的默认行为\n","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### UniEvent 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"CustomEvent":{"name":"## CustomEvent","description":"","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | - |\n| detail | T | 是 | - | - | - |\n\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | - |\n| options | any | 是 | - | - | - |\n\n### CustomEvent 的属性值 @customevent-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| detail | T | 是 | - | - | - |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"\n阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"\n阻止当前事件的默认行为\n","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### CustomEvent 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"MouseEvent":{"name":"## MouseEvent","description":"","extends":"","param":"\n### MouseEvent 的属性值 @mouseevent-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n| x | number | 是 | - | - | 相对于页面可显示区域左边的距离，同`clientX` |\n| y | number | 是 | - | - | 相对于页面可显示区域顶部的距离，同`clientY` |\n| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"\n阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"\n阻止当前事件的默认行为\n","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### MouseEvent 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"TouchEvent":{"name":"## TouchEvent","description":"","extends":"","param":"\n### TouchEvent 的属性值 @touchevent-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| touches | Array\\<**UniTouch**\\> | 是 | - | - | 当前停留在屏幕中的触摸点信息的数组 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n@| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n@| identifier | number | 是 | - | - | 触摸点的标识符。这个值在这根手指所引发的所有事件中保持一致，直到手指抬起。 |\n@| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n@| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n@| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n@| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n@| force | number \\| null | 否 | - | - | 返回当前触摸点按下的压力大小 |\n| changedTouches | Array\\<**UniTouch**\\> | 是 | - | - | 当前变化的触摸点信息的数组 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n@| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n@| identifier | number | 是 | - | - | 触摸点的标识符。这个值在这根手指所引发的所有事件中保持一致，直到手指抬起。 |\n@| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n@| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n@| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n@| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n@| force | number \\| null | 否 | - | - | 返回当前触摸点按下的压力大小 |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"\n阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"\n阻止当前事件的默认行为\n","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### TouchEvent 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UniTouch":{"name":"## UniTouch","description":"","extends":"","param":"\n### UniTouch 的属性值 @unitouch-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n| identifier | number | 是 | - | - | 触摸点的标识符。这个值在这根手指所引发的所有事件中保持一致，直到手指抬起。 |\n| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n| force | number \\| null | 否 | - | - | 返回当前触摸点按下的压力大小 |\n","compatibility":"### UniTouch 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"Touch":{"name":"## Touch","description":"","extends":"","param":"\n### Touch 的属性值 @touch-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n| identifier | number | 是 | - | - | 触摸点的标识符。这个值在这根手指所引发的所有事件中保持一致，直到手指抬起。 |\n| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n| force | number \\| null | 否 | - | - | 返回当前触摸点按下的压力大小 |\n","compatibility":"### Touch 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UniCustomEvent":{"name":"## UniCustomEvent","description":"","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | - |\n| detail | T | 是 | - | - | - |\n\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | - |\n| options | any | 是 | - | - | - |\n\n### UniCustomEvent 的属性值 @unicustomevent-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| detail | T | 是 | - | - | - |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"\n阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"\n阻止当前事件的默认行为\n","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### UniCustomEvent 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UniMouseEvent":{"name":"## UniMouseEvent","description":"","extends":"","param":"\n### UniMouseEvent 的属性值 @unimouseevent-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n| x | number | 是 | - | - | 相对于页面可显示区域左边的距离，同`clientX` |\n| y | number | 是 | - | - | 相对于页面可显示区域顶部的距离，同`clientY` |\n| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"\n阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"\n阻止当前事件的默认行为\n","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### UniMouseEvent 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UniTouchEvent":{"name":"## UniTouchEvent","description":"","extends":"","param":"\n### UniTouchEvent 的属性值 @unitouchevent-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| touches | Array\\<**UniTouch**\\> | 是 | - | - | 当前停留在屏幕中的触摸点信息的数组 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n@| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n@| identifier | number | 是 | - | - | 触摸点的标识符。这个值在这根手指所引发的所有事件中保持一致，直到手指抬起。 |\n@| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n@| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n@| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n@| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n@| force | number \\| null | 否 | - | - | 返回当前触摸点按下的压力大小 |\n| changedTouches | Array\\<**UniTouch**\\> | 是 | - | - | 当前变化的触摸点信息的数组 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n@| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n@| identifier | number | 是 | - | - | 触摸点的标识符。这个值在这根手指所引发的所有事件中保持一致，直到手指抬起。 |\n@| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n@| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n@| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n@| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n@| force | number \\| null | 否 | - | - | 返回当前触摸点按下的压力大小 |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"\n阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"\n阻止当前事件的默认行为\n","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### UniTouchEvent 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UniPointerEvent":{"name":"## UniPointerEvent","description":"","extends":"","param":"\n### UniPointerEvent 的属性值 @unipointerevent-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n| x | number | 是 | - | - | 相对于页面可显示区域左边的距离，同`clientX` |\n| y | number | 是 | - | - | 相对于页面可显示区域顶部的距离，同`clientY` |\n| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"\n阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"\n阻止当前事件的默认行为\n","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### UniPointerEvent 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"Element":{"name":"## Element","description":"","extends":"","param":"\n### Element 的属性值 @element-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| classList | Array\\ | 是 | - | - | 只读属性 获取当前元素的的 class 属性的动态集合。 |\n| firstChild | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| lastChild | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| parentElement | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| previousSibling | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| nextElementSibling | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| children | Array\\<[UniElement](/dom/unielement.md)\\> | 是 | - | - | 只读属性 获取当前元素包含的子元素的集合 |\n| tagName | string | 是 | - | - | 只读属性 获取当前元素的标签名 |\n| nodeName | string | 是 | - | - | 只读属性 获取当前元素的元素名称 |\n| dataset | Map\\ | 是 | - | - | 只读属性 获取元素上自定义数据属性（data-*）的集合 |\n| attributes | Map\\ | 是 | - | - | 只读属性 获取元素上所有属性元素的集合 |\n| style | [CSSStyleDeclaration](/dom/cssstyledeclaration.md) | 是 | - | - | 只读属性 获取元素的CSS样式对象 |\n| scrollWidth | number | 是 | - | - | 只读属性 获取可滚动元素内容的总宽度，仅scroll-view、list-view组件支持，其他组件返回视图宽度 |\n| scrollHeight | number | 是 | - | - | 只读属性 获取可滚动元素内容的总高度，仅scroll-view、list-view组件支持，其他组件返回视图高度 |\n| scrollLeft | number | 是 | - | - | 获取或修改元素滚动条到元素左边的距离像素数，仅scroll-view、list-view组件支持。其他组件返回0 |\n| scrollTop | number | 是 | - | - | 获取或修改元素滚动条到元素顶部的距离像素数，仅scroll-view、list-view组件支持。其他组件返回0 |\n| offsetLeft | number | 是 | - | - | 只读属性 元素的左边界偏移值 单位px |\n| offsetTop | number | 是 | - | - | 只读属性 元素的顶部边界偏移值 单位px |\n| offsetWidth | number | 是 | - | - | 只读属性 元素的布局宽度，宽度包含border、padding的数据值 单位px |\n| offsetHeight | number | 是 | - | - | 只读属性 元素的布局高度，高度包含border、padding的数据值 单位px |\n| ext | Map\\ | 是 | - | - | 只读属性 扩展属性 |\n","methods":{"takeSnapshot":{"name":"#### takeSnapshot(options) @takesnapshot","description":"\n对当前组件进行截图，调用此方法会将当前组件（包含子节点）渲染结果导出成图片。\n成功会返回图片对应的临时文件路径，目前默认png格式\n","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [TakeSnapshotOptions](#takesnapshotoptions-values) | 是 | - | - | 组件截图的参数对象 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| type | string \\| null | 否 | \"file\" | - | 截图导出类型，目前仅支持 'file' 保存到临时文件目录 |\n@| format | string \\| null | 否 | \"png\" | - | 截图文件格式，目前仅支持 'png' |\n@| success | (res: [TakeSnapshotSuccess](#takesnapshotsuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (res: [TakeSnapshotFail](#takesnapshotfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### TakeSnapshotSuccess 的属性值 @takesnapshotsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tempFilePath | string | 是 | - | - | 截图保存的临时文件路径 |\n\n##### TakeSnapshotFail 的属性值 @takesnapshotfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"##### takeSnapshot 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.93 | 4.11 | x |\n","tutorial":""},"appendChild":{"name":"#### appendChild(aChild) @appendchild","description":"\n将一个元素添加到指定父元素的子元素列表的末尾处。如果将被插入的元素已经存在于当前文档的文档树中，那么将会它从原先的位置移动到新的位置。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| aChild | [UniElement](/dom/unielement.md) | 是 | - | - | 插入子元素对象 | \n","returnValue":"","compatibility":"##### appendChild 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"insertBefore":{"name":"#### insertBefore(newChild, refChild?) @insertbefore","description":"\n在参考元素之前插入一个拥有指定父元素的子元素。如果给定的子元素是对文档中现有元素的引用，insertBefore() 会将其从当前位置移动到新位置。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| newChild | [UniElement](/dom/unielement.md) | 是 | - | - | 插入子元素对象 |\n| refChild | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UniElement](/dom/unielement.md) \\| null | 否 |\n \n","compatibility":"##### insertBefore 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"setAttribute":{"name":"#### setAttribute(key, value) @setattribute","description":"\n设置指定元素上的某个属性值。如果设置的属性已经存在，则更新该属性值；否则使用指定的名称和值添加一个新的属性。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 属性名称 |\n| value | string | 是 | - | - | 属性值域 | \n","returnValue":"","compatibility":"##### setAttribute 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"getAttribute":{"name":"#### getAttribute(key) @getattribute","description":"\n获取元素指定的属性值，如果指定的属性不存在则返回null。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 属性名称 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| string \\| null | 否 |\n \n","compatibility":"##### getAttribute 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"hasAttribute":{"name":"#### hasAttribute(key) @hasattribute","description":"\n返回改元素是否包含有指定的属性，属性存在则返回true，否则返回false。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 属性名称 | \n","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n","compatibility":"##### hasAttribute 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"removeAttribute":{"name":"#### removeAttribute(key) @removeattribute","description":"\n从元素中删除一个属性，如果指定的属性不存在，则不做任何操作，也不会产生错误。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 属性名称 | \n","returnValue":"","compatibility":"##### removeAttribute 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"getBoundingClientRect":{"name":"#### getBoundingClientRect() @getboundingclientrect","description":"\n获取元素的大小及其相对于窗口的位置信息。","param":"","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| [DOMRect](/dom/domrect.md) |\n \n","compatibility":"##### getBoundingClientRect 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"getDrawableContext":{"name":"#### getDrawableContext() @getdrawablecontext","description":"\n获取组件的绘制对象，仅uvue页面中的 view 组件支持，其它组件不支持则返回null。","param":"","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [DrawableContext](/dom/drawablecontext.md) \\| null | 否 |\n \n","compatibility":"##### getDrawableContext 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | x |\n","tutorial":""},"addEventListener":{"name":"#### addEventListener(type, callback) @addeventlistener","description":"\n将指定的监听器注册到元素对象上，当该对象触发指定的事件时，指定的回调函数就会被执行。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件类型 |\n| callback | (event: T) => R | 是 | - | - | 事件监听器 T表示event类型，R表示返回值类型 | \n","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| UniCallbackWrapper |\n \n","compatibility":"##### addEventListener 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"removeEventListener":{"name":"#### removeEventListener(type, callbackWrapper) @removeeventlistener","description":"\n删除使用 addEventListener 方法添加的事件监听器。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件类型 |\n| callbackWrapper | UniCallbackWrapper | 是 | - | - | 事件监听回调封装类 | \n","returnValue":"","compatibility":"##### removeEventListener 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"removeChild":{"name":"#### removeChild(aChild) @removechild","description":"\n从元素中删除一个子元素，返回删除的元素。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| aChild | [UniElement](/dom/unielement.md) | 是 | - | - | 被删除子元素对象 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UniElement](/dom/unielement.md) \\| null | 否 |\n \n","compatibility":"##### removeChild 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"remove":{"name":"#### remove() @remove","description":"\n把元素对象从它所属的 DOM 树中删除。","param":"","returnValue":"","compatibility":"##### remove 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"dispatchEvent":{"name":"#### dispatchEvent(type, value) @dispatchevent","description":"\n向一个指定的事件目标派发一个 Event，并以合适的顺序（同步地）调用此事件的监听器回调函数。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件类型 |\n| value | [UniEvent](/component/common#unievent) | 是 | - | - | 事件返回对象 | \n","returnValue":"","compatibility":"##### dispatchEvent 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"scrollTo":{"name":"#### scrollTo(x, y) @scrollto","description":"\n使界面滚动到给定元素的指定坐标位置 仅scroll-view、list-view组件支持","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | x轴要滚动到坐标位置(单位px) |\n| y | number | 是 | - | - | y轴要滚动到坐标位置(单位px) | \n","returnValue":"","compatibility":"##### scrollTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"scrollBy":{"name":"#### scrollBy(x, y) @scrollby","description":"\n使得元素滚动一段特定距离 仅scroll-view、list-view组件支持","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | x轴要滚动的距离(单位px) |\n| y | number | 是 | - | - | y轴要滚动的距离(单位px) | \n","returnValue":"","compatibility":"##### scrollBy 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"querySelector":{"name":"#### querySelector(selector) @queryselector","description":"\n返回文档中与指定选择器或选择器组匹配的第一个 Element对象。如果找不到匹配项，则返回null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| selector | [string.cssSelectorString](/uts/data-type.md#ide-string) | 是 | - | - | CSS 选择器字符串 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UniElement](/dom/unielement.md) \\| null | 否 |\n \n","compatibility":"##### querySelector 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"querySelectorAll":{"name":"#### querySelectorAll(selector) @queryselectorall","description":"\n返回与指定的选择器组匹配的文档中的元素列表","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| selector | [string.cssSelectorString](/uts/data-type.md#ide-string) | 是 | - | - | CSS 选择器字符串 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Array\\<[UniElement](/dom/unielement.md)\\> \\| null | 否 |\n \n","compatibility":"##### querySelectorAll 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"focus":{"name":"#### focus() @focus","description":"\n使元素获取焦点 仅input、Textarea组件支持","param":"","returnValue":"","compatibility":"##### focus 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"blur":{"name":"#### blur() @blur","description":"\n使元素丢失焦点 仅input、Textarea组件支持","param":"","returnValue":"","compatibility":"##### blur 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""}},"compatibility":"### Element 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UniResizeObserver":{"name":"## UniResizeObserver","description":"\n用于监视 UniElement 元素的大小变化。它可以观察一个或多个","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (entries: Array\\<**UniResizeObserverEntry**\\>) => void | 是 | - | - | 每当监视的元素调整大小时，回调该函数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| borderBoxSize | Array\\<**UniBorderBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素带有边框box大小的数组。 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| blockSize | number | 是 | - | - | 只读属性，被监视元素含边框box的高度 |\n@@| inlineSize | number | 是 | - | - | 只读属性，被监视元素含边框box的宽度 |\n@| contentBoxSize | Array\\<**UniContentBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素内容box大小的数组。 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| blockSize | number | 是 | - | - | 只读属性，被监视元素内容box的高度 |\n@@| inlineSize | number | 是 | - | - | 只读属性，被监视元素内容box的宽度 |\n@| devicePixelContentBoxSize | Array\\<**UniDevicePixelContentBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素内容box设备像素大小的数组。 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| blockSize | number | 是 | - | - | 只读属性，被监视元素内容box的设备像素高度 |\n@@| inlineSize | number | 是 | - | - | 只读属性，被监视元素内容box的设备像素宽度 |\n@| contentRect | [DOMRect](/dom/domrect.md) | 是 | - | - | 只读属性 包含被监视元素大小的DOMRect |\n@| target | [UniElement](/dom/unielement.md) | 是 | - | - | 只读属性 被监视的 UniElement |\n\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (entries: Array\\<**UniResizeObserverEntry**\\>, observer: [UniResizeObserver](/dom/uniresizeobserver.md)) => void | 是 | - | - | 每当监视的元素调整大小时，回调该函数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| borderBoxSize | Array\\<**UniBorderBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素带有边框box大小的数组。 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| blockSize | number | 是 | - | - | 只读属性，被监视元素含边框box的高度 |\n@@| inlineSize | number | 是 | - | - | 只读属性，被监视元素含边框box的宽度 |\n@| contentBoxSize | Array\\<**UniContentBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素内容box大小的数组。 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| blockSize | number | 是 | - | - | 只读属性，被监视元素内容box的高度 |\n@@| inlineSize | number | 是 | - | - | 只读属性，被监视元素内容box的宽度 |\n@| devicePixelContentBoxSize | Array\\<**UniDevicePixelContentBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素内容box设备像素大小的数组。 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| blockSize | number | 是 | - | - | 只读属性，被监视元素内容box的设备像素高度 |\n@@| inlineSize | number | 是 | - | - | 只读属性，被监视元素内容box的设备像素宽度 |\n@| contentRect | [DOMRect](/dom/domrect.md) | 是 | - | - | 只读属性 包含被监视元素大小的DOMRect |\n@| target | [UniElement](/dom/unielement.md) | 是 | - | - | 只读属性 被监视的 UniElement |\n","methods":{"disconnect":{"name":"#### disconnect() @disconnect","description":"\n取消所有的对 UniElement 目标的监视","param":"","returnValue":"","compatibility":"##### disconnect 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"observe":{"name":"#### observe(target) @observe","description":"\n监视指定 UniElement 大小变化","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| target | [UniElement](/dom/unielement.md) | 是 | - | - | 被监视的 UniElement | \n","returnValue":"","compatibility":"##### observe 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"unobserve":{"name":"#### unobserve(target) @unobserve","description":"\n结束对指定的 UniElement 的监视","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| target | [UniElement](/dom/unielement.md) | 是 | - | - | 取消监视的 UniElement | \n","returnValue":"","compatibility":"##### unobserve 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""}},"compatibility":"### UniResizeObserver 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/resize-observer/resize-observer.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\r\n\r\n\r\n\r\n\n\n```"},"UniResizeObserverEntry":{"name":"## UniResizeObserverEntry","description":"\nUniResizeObserverEntry 接口是传递给 UniResizeObserver() 构造函数中的回调函数参数的对象","extends":"","param":"\n### UniResizeObserverEntry 的属性值 @uniresizeobserverentry-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| borderBoxSize | Array\\<**UniBorderBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素带有边框box大小的数组。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| blockSize | number | 是 | - | - | 只读属性，被监视元素含边框box的高度 |\n@| inlineSize | number | 是 | - | - | 只读属性，被监视元素含边框box的宽度 |\n| contentBoxSize | Array\\<**UniContentBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素内容box大小的数组。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| blockSize | number | 是 | - | - | 只读属性，被监视元素内容box的高度 |\n@| inlineSize | number | 是 | - | - | 只读属性，被监视元素内容box的宽度 |\n| devicePixelContentBoxSize | Array\\<**UniDevicePixelContentBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素内容box设备像素大小的数组。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| blockSize | number | 是 | - | - | 只读属性，被监视元素内容box的设备像素高度 |\n@| inlineSize | number | 是 | - | - | 只读属性，被监视元素内容box的设备像素宽度 |\n| contentRect | [DOMRect](/dom/domrect.md) | 是 | - | - | 只读属性 包含被监视元素大小的DOMRect |\n| target | [UniElement](/dom/unielement.md) | 是 | - | - | 只读属性 被监视的 UniElement |\n","compatibility":"### UniResizeObserverEntry 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |"},"UniBorderBoxSize":{"name":"## UniBorderBoxSize","description":"\n被监视的元素带有边框box的大小","extends":"","param":"\n### UniBorderBoxSize 的属性值 @uniborderboxsize-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| blockSize | number | 是 | - | - | 只读属性，被监视元素含边框box的高度 |\n| inlineSize | number | 是 | - | - | 只读属性，被监视元素含边框box的宽度 |\n","compatibility":"### UniBorderBoxSize 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |"},"UniContentBoxSize":{"name":"## UniContentBoxSize","description":"\n被监视的元素内容box的大小","extends":"","param":"\n### UniContentBoxSize 的属性值 @unicontentboxsize-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| blockSize | number | 是 | - | - | 只读属性，被监视元素内容box的高度 |\n| inlineSize | number | 是 | - | - | 只读属性，被监视元素内容box的宽度 |\n","compatibility":"### UniContentBoxSize 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |"},"UniDevicePixelContentBoxSize":{"name":"## UniDevicePixelContentBoxSize","description":"\n被监视的元素内容box的设备像素大小","extends":"","param":"\n### UniDevicePixelContentBoxSize 的属性值 @unidevicepixelcontentboxsize-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| blockSize | number | 是 | - | - | 只读属性，被监视元素内容box的设备像素高度 |\n| inlineSize | number | 是 | - | - | 只读属性，被监视元素内容box的设备像素宽度 |\n","compatibility":"### UniDevicePixelContentBoxSize 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |"},"UniError":{"name":"## UniError","description":"\nuni api统一错误信息对象 ","extends":"","param":"\n### 构造函数\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| message | string | 是 | - | - | 统一错误描述信息 |\n\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| message | string | 是 | - | - | 统一错误描述信息 |\n| options | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | - | 源错误对象，原始错误对象应该包含在 options.cause 属性中 |\n\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| errCode | number | 是 | - | - | 统一错误码 |\n| errMsg | string | 是 | - | - | 统一错误描述信息 |\n\n### UniError 的属性值 @unierror-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| errCode | number | 是 | - | - | 统一错误码 |\n| errMsg | string | 是 | - | - | 统一错误描述信息 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | UTS错误信息对象 |\n| name | string | 是 | - | - | - |\n| message | string | 是 | - | - | - |\n","compatibility":"### UniError 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"Error":{"name":"## Error","description":"\nUTS错误信息对象","extends":"","param":"\n### 构造函数\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| message | string | 是 | - | - | - |\n\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| message | string | 是 | - | - | - |\n| options | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | - | - |\n\n### Error 的属性值 @error-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - |\n| message | string | 是 | - | - | - |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | UTS错误信息对象 |\n","compatibility":"### Error 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"general-attribute":{"name":"组件公共属性","description":"","attribute":"| 名称 | 类型 | 描述 |\n| :- | :- | :- |\n| id | string(string.IDString) | 组件的唯一标识，一般用于获取组件上下文对象 |\n| style | string | 组件的内联样式，可以动态设置的内联样式 |\n| class | string(string.ClassString) | 组件的样式类，在对应的 css 中定义的样式类 |\n| ref | string | vue中组件的唯一标识，用来给子组件注册引用信息 |\n| data-* | any | 自定义属性，组件上触发的事件时，会发送给事件处理函数 |\n| android-* | any | App-Android平台专有属性，详见[App-Android平台专有属性](https://doc.dcloud.net.cn/uni-app-x/component/common.html#attribute-android)章节 |","compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| id | 3.9 | 4.11 | 4.0 |\n| style | 3.9 | 4.11 | 4.0 |\n| class | 3.9 | 4.11 | 4.0 |\n| ref | 3.9 | 4.11 | 4.0 |\n| data-* | 3.9 | 4.11 | 4.0 |\n| android-* | 3.9 | x | 4.0 |","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/component/general-attribute/general-attribute.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/component/general-attribute/general-attribute\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\nexport default {\n data() {\n return {\n title: 'general-attribute',\n generalId: 'general-id',\n generalClass: 'general-class',\n generalName: 'general-name',\n generalTitle: 'general-title',\n generalData: 'general-data',\n generalStyle: 'background-color: aqua',\n validateGeneralAttrText: '验证基础属性',\n hoverClass: 'hover-class',\n validateViewAttrText: '验证 view 属性',\n changeHeightByRefText: '通过 ref 修改高度',\n }\n },\n methods: {\n validateGeneralAttributes() {\n const generalTarget = this.$refs['general-target'] as UniElement\n const generalId = generalTarget.getAttribute('id')\n if (generalId != this.generalId) {\n this.validateGeneralAttrText = '基础属性 id 验证失败'\n return\n }\n // #ifdef APP\n if (!generalTarget.classList.includes('general-class')) {\n // #endif\n // #ifdef WEB\n if (!Array.from(generalTarget.classList).includes('general-class')) {\n // #endif\n this.validateGeneralAttrText = '基础属性 class 验证失败'\n return\n }\n const generalName = generalTarget.getAttribute('name')\n if (generalName != this.generalName) {\n this.validateGeneralAttrText = '基础属性 name 验证失败'\n return\n }\n const generalTitle = generalTarget.getAttribute('title')\n if (generalTitle != this.generalTitle) {\n this.validateGeneralAttrText = '基础属性 title 验证失败'\n return\n }\n const generalData = generalTarget.getAttribute('data-test')\n if (generalData != this.generalData) {\n this.validateGeneralAttrText = '基础属性 data-test 验证失败'\n return\n }\n this.validateGeneralAttrText = '基础属性验证成功'\n },\n changeHeight(){\n const generalTarget = this.$refs['general-target'] as UniElement\n this.changeHeightByRefText = '已通过 ref 修改高度'\n generalTarget.style.setProperty('height', '200px')\n }\n },\n}\n\n```\n:::"},"general-event":{"name":"组件公共事件","description":"","attribute":"| 名称 | 类型 | 描述 |\n| :- | :- | :- |\n| @click | (event: [UniPointerEvent](/component/common#unipointerevent)) => void | 手指触摸后马上离开。与tap相同，（推荐使用tap事件代替），冒泡事件 |\n| @mousedown | (event: [UniMouseEvent](/component/common#unimouseevent)) => void | 鼠标在元素上点击后触发 |\n| @mousemove | (event: [UniMouseEvent](/component/common#unimouseevent)) => void | 鼠标在元素上移动时触发 |\n| @mouseup | (event: [UniMouseEvent](/component/common#unimouseevent)) => void | 鼠标主按钮在元素上松开时触发 |\n| @touchstart | (event: [UniTouchEvent](/component/common#unitouchevent)) => void | 手指触摸动作开始，冒泡事件，event.type 值为 touchstart |\n| @touchmove | (event: [UniTouchEvent](/component/common#unitouchevent)) => void | 手指触摸后移动，冒泡事件，event.type 值为 touchmove |\n| @touchcancel | (event: [UniTouchEvent](/component/common#unitouchevent)) => void | 手指触摸动作被打断，如来电提醒，弹窗，冒泡事件，event.type 值为 touchcancel |\n| @touchend | (event: [UniTouchEvent](/component/common#unitouchevent)) => void | 手指触摸动作结束，冒泡事件，event.type 值为 touchend |\n| @tap | (event: [UniPointerEvent](/component/common#unipointerevent)) => void | 手指触摸后马上离开，冒泡事件 |\n| @longpress | (event: [UniTouchEvent](/component/common#unitouchevent)) => void | 如果一个组件被绑定了 longpress 事件，那么当用户手指触摸后，超过350ms再离开会触发，冒泡事件 |\n| @longtap | (event: [UniTouchEvent](/component/common#unitouchevent)) => void | 手指触摸后，超过350ms再离开（推荐使用 longpress 事件代替） |\n| @transitionend | (event: [UniEvent](/component/common#unievent)) => void | transition 效果结束时触发 |","compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| @click | 3.9 | 4.11 | 4.0 |\n| @mousedown | x | x | 4.0 |\n| @mousemove | x | x | 4.0 |\n| @mouseup | x | x | 4.0 |\n| @touchstart | 3.9 | 4.11 | 4.0 |\n| @touchmove | 3.9 | 4.11 | 4.0 |\n| @touchcancel | 3.9 | 4.11 | 4.0 |\n| @touchend | 3.9 | 4.11 | 4.0 |\n| @tap | 3.9 | 4.11 | 4.0 |\n| @longpress | 3.9 | 4.11 | 4.0 |\n| @longtap | 3.9 | 4.11 | 4.0 |\n| @transitionend | 3.93 | 4.11 | 4.0 |","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/component/general-event/general-event.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/component/general-event/general-event\n>Template\n```vue\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: 'general-event',\n onTouchStartTime: 0,\n touchStartEvent: null as TouchEvent | null,\n touchCancelEvent: null as TouchEvent | null,\n onTouchMoveTime: 0,\n touchMoveEvent: null as TouchEvent | null,\n onTouchEndTime: 0,\n longPressEvent: null as TouchEvent | null,\n touchEndEvent: null as TouchEvent | null,\n onTapTime: 0,\n tapEvent: null as PointerEvent | null,\n onClickTime: 0,\n clickEvent: null as PointerEvent | null,\n onLongPressTime: 0,\n }\n },\n methods: {\n onTouchStart(e : TouchEvent) {\n this.touchStartEvent = e\n this.onTouchStartTime = Date.now()\n console.log('onTouchStart')\n },\n onTouchCancel(e : TouchEvent) {\n this.touchCancelEvent = e\n console.log('onTouchCancel')\n },\n onTouchMove(e : TouchEvent) {\n this.touchMoveEvent = e\n this.onTouchMoveTime = Date.now()\n console.log('onTouchMove')\n },\n onLongPress(e : TouchEvent) {\n this.longPressEvent = e\n this.onLongPressTime = Date.now()\n console.log('onLongPress')\n },\n onTouchEnd(e : TouchEvent) {\n this.touchEndEvent = e\n this.onTouchEndTime = Date.now()\n console.log('onTouchEnd')\n },\n onTap(e : PointerEvent) {\n this.tapEvent = e\n this.onTapTime = Date.now()\n console.log('onTap')\n },\n onClick(e : PointerEvent) {\n this.clickEvent = e\n this.onClickTime = Date.now()\n console.log('onClick')\n },\n },\n }\n\n```\n:::"}} \ No newline at end of file +{"Event":{"name":"## Event","description":"","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件的名称 |\n\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件的名称 |\n| eventInit | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | - | 事件初始参数。支持字段：`bubbles`表明该事件是否冒泡。可选，默认为false；`cancelable`表明该事件是否可以被取消。可选，默认为false。 |\n\n### Event 的属性值 @event-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"阻止当前事件的默认行为
","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### Event 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UTSJSONObject":{"name":"## UTSJSONObject","description":"","extends":"","param":"","methods":{"get":{"name":"#### get(key) @get","description":"获取一个 属性，返回类型是any 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| any \\| null | 否 |\n \n","compatibility":"##### get 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#get)\n"},"set":{"name":"#### set(key, value) @set","description":"获取一个 属性，返回类型是any 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - |\n| value | any | 是 | - | - | - | \n","returnValue":"","compatibility":"##### set 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#set)\n"},"getAny":{"name":"#### getAny(key) @getany","description":"获取一个 属性，返回类型是any 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| any \\| null | 否 |\n \n","compatibility":"##### getAny 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getAny)\n"},"getBoolean":{"name":"#### getBoolean(key) @getboolean","description":"获取一个Boolean属性，返回类型是Boolean 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| boolean \\| null | 否 |\n \n","compatibility":"##### getBoolean 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getBoolean)\n"},"getNumber":{"name":"#### getNumber(key) @getnumber","description":"获取一个number属性，返回类型是number 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| number \\| null | 否 |\n \n","compatibility":"##### getNumber 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getNumber)\n"},"getString":{"name":"#### getString(key) @getstring","description":"获取一个string属性，返回类型是string 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| string \\| null | 否 |\n \n","compatibility":"##### getString 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getString)\n"},"getJSON":{"name":"#### getJSON(key) @getjson","description":"获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \\| null | 否 |\n \n","compatibility":"##### getJSON 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getJSON)\n"},"getArray":{"name":"#### getArray(key) @getarray","description":"获取一个Array属性，返回类型是Array 或者 null, 数组元素类型由泛型T决定","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| T[] \\| null | 否 |\n \n","compatibility":"##### getArray 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getArray)\n"},"toMap":{"name":"#### toMap() @tomap","description":"将当前 UTSJSONObject 实例转换为 Map 实例。","param":"","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| Map\\ |\n \n","compatibility":"##### toMap 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#toMap)\n"}},"compatibility":"### UTSJSONObject 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UniElement":{"name":"## UniElement","description":"UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。","extends":"","param":"\n### UniElement 的属性值 @unielement-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| classList | Array\\ | 是 | - | - | 只读属性 获取当前元素的的 class 属性的动态集合。 |\n| firstChild | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| lastChild | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| parentElement | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| previousSibling | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| nextElementSibling | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| children | Array\\<[UniElement](/dom/unielement.md)\\> | 是 | - | - | 只读属性 获取当前元素包含的子元素的集合 |\n| tagName | string | 是 | - | - | 只读属性 获取当前元素的标签名 |\n| nodeName | string | 是 | - | - | 只读属性 获取当前元素的元素名称 |\n| dataset | Map\\ | 是 | - | - | 只读属性 获取元素上自定义数据属性（data-*）的集合 |\n| attributes | Map\\ | 是 | - | - | 只读属性 获取元素上所有属性元素的集合 |\n| style | [CSSStyleDeclaration](/dom/cssstyledeclaration.md) | 是 | - | - | 只读属性 获取元素的CSS样式对象 |\n| scrollWidth | number | 是 | - | - | 只读属性 获取可滚动元素内容的总宽度，仅scroll-view、list-view组件支持，其他组件返回视图宽度 |\n| scrollHeight | number | 是 | - | - | 只读属性 获取可滚动元素内容的总高度，仅scroll-view、list-view组件支持，其他组件返回视图高度 |\n| scrollLeft | number | 是 | - | - | 获取或修改元素滚动条到元素左边的距离像素数，仅scroll-view、list-view组件支持。其他组件返回0 |\n| scrollTop | number | 是 | - | - | 获取或修改元素滚动条到元素顶部的距离像素数，仅scroll-view、list-view组件支持。其他组件返回0 |\n| offsetLeft | number | 是 | - | - | 只读属性 元素的左边界偏移值 单位px |\n| offsetTop | number | 是 | - | - | 只读属性 元素的顶部边界偏移值 单位px |\n| offsetWidth | number | 是 | - | - | 只读属性 元素的布局宽度，宽度包含border、padding的数据值 单位px |\n| offsetHeight | number | 是 | - | - | 只读属性 元素的布局高度，高度包含border、padding的数据值 单位px |\n| ext | Map\\ | 是 | - | - | 只读属性 扩展属性 |\n","methods":{"takeSnapshot":{"name":"#### takeSnapshot(options) @takesnapshot","description":"对当前组件进行截图，调用此方法会将当前组件（包含子节点）渲染结果导出成图片。
成功会返回图片对应的临时文件路径，目前默认png格式
","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [TakeSnapshotOptions](#takesnapshotoptions-values) | 是 | - | - | 组件截图的参数对象 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| type | string \\| null | 否 | \"file\" | - | 截图导出类型，目前仅支持 'file' 保存到临时文件目录 |\n@| format | string \\| null | 否 | \"png\" | - | 截图文件格式，目前仅支持 'png' |\n@| success | (res: [TakeSnapshotSuccess](#takesnapshotsuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (res: [TakeSnapshotFail](#takesnapshotfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### TakeSnapshotSuccess 的属性值 @takesnapshotsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tempFilePath | string | 是 | - | - | 截图保存的临时文件路径 |\n\n##### TakeSnapshotFail 的属性值 @takesnapshotfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"##### takeSnapshot 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.93 | 4.11 | x |\n","tutorial":""},"appendChild":{"name":"#### appendChild(aChild) @appendchild","description":"将一个元素添加到指定父元素的子元素列表的末尾处。如果将被插入的元素已经存在于当前文档的文档树中，那么将会它从原先的位置移动到新的位置。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| aChild | [UniElement](/dom/unielement.md) | 是 | - | - | 插入子元素对象 | \n","returnValue":"","compatibility":"##### appendChild 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"insertBefore":{"name":"#### insertBefore(newChild, refChild?) @insertbefore","description":"在参考元素之前插入一个拥有指定父元素的子元素。如果给定的子元素是对文档中现有元素的引用，insertBefore() 会将其从当前位置移动到新位置。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| newChild | [UniElement](/dom/unielement.md) | 是 | - | - | 插入子元素对象 |\n| refChild | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UniElement](/dom/unielement.md) \\| null | 否 |\n \n","compatibility":"##### insertBefore 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"setAttribute":{"name":"#### setAttribute(key, value) @setattribute","description":"设置指定元素上的某个属性值。如果设置的属性已经存在，则更新该属性值；否则使用指定的名称和值添加一个新的属性。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 属性名称 |\n| value | string | 是 | - | - | 属性值域 | \n","returnValue":"","compatibility":"##### setAttribute 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"getAttribute":{"name":"#### getAttribute(key) @getattribute","description":"获取元素指定的属性值，如果指定的属性不存在则返回null。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 属性名称 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| string \\| null | 否 |\n \n","compatibility":"##### getAttribute 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"hasAttribute":{"name":"#### hasAttribute(key) @hasattribute","description":"返回改元素是否包含有指定的属性，属性存在则返回true，否则返回false。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 属性名称 | \n","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n","compatibility":"##### hasAttribute 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"removeAttribute":{"name":"#### removeAttribute(key) @removeattribute","description":"从元素中删除一个属性，如果指定的属性不存在，则不做任何操作，也不会产生错误。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 属性名称 | \n","returnValue":"","compatibility":"##### removeAttribute 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"getBoundingClientRect":{"name":"#### getBoundingClientRect() @getboundingclientrect","description":"获取元素的大小及其相对于窗口的位置信息。","param":"","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| [DOMRect](/dom/domrect.md) |\n \n","compatibility":"##### getBoundingClientRect 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"getDrawableContext":{"name":"#### getDrawableContext() @getdrawablecontext","description":"获取组件的绘制对象，仅uvue页面中的 view 组件支持，其它组件不支持则返回null。","param":"","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [DrawableContext](/dom/drawablecontext.md) \\| null | 否 |\n \n","compatibility":"##### getDrawableContext 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | x |\n","tutorial":""},"addEventListener":{"name":"#### addEventListener(type, callback) @addeventlistener","description":"将指定的监听器注册到元素对象上，当该对象触发指定的事件时，指定的回调函数就会被执行。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件类型 |\n| callback | (event: T) => R | 是 | - | - | 事件监听器 T表示event类型，R表示返回值类型 | \n","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| UniCallbackWrapper |\n \n","compatibility":"##### addEventListener 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"removeEventListener":{"name":"#### removeEventListener(type, callbackWrapper) @removeeventlistener","description":"删除使用 addEventListener 方法添加的事件监听器。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件类型 |\n| callbackWrapper | UniCallbackWrapper | 是 | - | - | 事件监听回调封装类 | \n","returnValue":"","compatibility":"##### removeEventListener 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"removeChild":{"name":"#### removeChild(aChild) @removechild","description":"从元素中删除一个子元素，返回删除的元素。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| aChild | [UniElement](/dom/unielement.md) | 是 | - | - | 被删除子元素对象 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UniElement](/dom/unielement.md) \\| null | 否 |\n \n","compatibility":"##### removeChild 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"remove":{"name":"#### remove() @remove","description":"把元素对象从它所属的 DOM 树中删除。","param":"","returnValue":"","compatibility":"##### remove 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"dispatchEvent":{"name":"#### dispatchEvent(type, value) @dispatchevent","description":"向一个指定的事件目标派发一个 Event，并以合适的顺序（同步地）调用此事件的监听器回调函数。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件类型 |\n| value | [UniEvent](/component/common#unievent) | 是 | - | - | 事件返回对象 | \n","returnValue":"","compatibility":"##### dispatchEvent 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"scrollTo":{"name":"#### scrollTo(x, y) @scrollto","description":"使界面滚动到给定元素的指定坐标位置 仅scroll-view、list-view组件支持","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | x轴要滚动到坐标位置(单位px) |\n| y | number | 是 | - | - | y轴要滚动到坐标位置(单位px) | \n","returnValue":"","compatibility":"##### scrollTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"scrollBy":{"name":"#### scrollBy(x, y) @scrollby","description":"使得元素滚动一段特定距离 仅scroll-view、list-view组件支持","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | x轴要滚动的距离(单位px) |\n| y | number | 是 | - | - | y轴要滚动的距离(单位px) | \n","returnValue":"","compatibility":"##### scrollBy 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"querySelector":{"name":"#### querySelector(selector) @queryselector","description":"返回文档中与指定选择器或选择器组匹配的第一个 Element对象。如果找不到匹配项，则返回null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| selector | [string.cssSelectorString](/uts/data-type.md#ide-string) | 是 | - | - | CSS 选择器字符串 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UniElement](/dom/unielement.md) \\| null | 否 |\n \n","compatibility":"##### querySelector 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"querySelectorAll":{"name":"#### querySelectorAll(selector) @queryselectorall","description":"返回与指定的选择器组匹配的文档中的元素列表","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| selector | [string.cssSelectorString](/uts/data-type.md#ide-string) | 是 | - | - | CSS 选择器字符串 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Array\\<[UniElement](/dom/unielement.md)\\> \\| null | 否 |\n \n","compatibility":"##### querySelectorAll 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"focus":{"name":"#### focus() @focus","description":"使元素获取焦点 仅input、Textarea组件支持","param":"","returnValue":"","compatibility":"##### focus 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"blur":{"name":"#### blur() @blur","description":"使元素丢失焦点 仅input、Textarea组件支持","param":"","returnValue":"","compatibility":"##### blur 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""}},"compatibility":"### UniElement 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"CSSStyleDeclaration":{"name":"## CSSStyleDeclaration","description":"CSSStyleDeclaration表示一个CSS 声明块对象，它是一个 CSS 属性键值对的集合，暴露样式信息和各种与样式相关的方法和属性。","extends":"","param":"","methods":{"setProperty":{"name":"#### setProperty(name, value?) @setproperty","description":"对CSS指定样式设置一个新值，如有此样式已存在则更新。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string ([string.cssPropertyString](/uts/data-type.md#ide-string)) | 是 | - | - | CSS样式名称 |\n| value | any \\| null | 否 | - | - | 要设置的新CSS样式值 | \n","returnValue":"","compatibility":"##### setProperty 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"getPropertyValue":{"name":"#### getPropertyValue(property) @getpropertyvalue","description":"获取CSS指定的样式值，如果指定的样式不存在则返回null。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| property | string ([string.cssPropertyString](/uts/data-type.md#ide-string)) | 是 | - | - | 要获取的CSS样式名称 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| any \\| null | 否 |\n \n","compatibility":"##### getPropertyValue 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"removeProperty":{"name":"#### removeProperty(property) @removeproperty","description":"删除CSS指定的样式值","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| property | string ([string.cssPropertyString](/uts/data-type.md#ide-string)) | 是 | - | - | 要删除的CSS样式名称 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| any \\| null | 否 |\n \n","compatibility":"##### removeProperty 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""}},"compatibility":"### CSSStyleDeclaration 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"TakeSnapshotOptions":{"name":"## TakeSnapshotOptions","description":"组件截图的参数配置选项","extends":"","param":"\n### TakeSnapshotOptions 的属性值 @takesnapshotoptions-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string \\| null | 否 | \"file\" | - | 截图导出类型，目前仅支持 'file' 保存到临时文件目录 |\n| format | string \\| null | 否 | \"png\" | - | 截图文件格式，目前仅支持 'png' |\n| success | (res: **TakeSnapshotSuccess**) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| tempFilePath | string | 是 | - | - | 截图保存的临时文件路径 |\n| fail | (res: **TakeSnapshotFail**) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| errMsg | string | 是 | - | - | - |\n| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","compatibility":"### TakeSnapshotOptions 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"TakeSnapshotSuccessCallback":{"name":"## TakeSnapshotSuccessCallback","description":"","extends":"","param":"","compatibility":"### TakeSnapshotSuccessCallback 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"TakeSnapshotSuccess":{"name":"## TakeSnapshotSuccess","description":"","extends":"","param":"\n### TakeSnapshotSuccess 的属性值 @takesnapshotsuccess-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tempFilePath | string | 是 | - | - | 截图保存的临时文件路径 |\n","compatibility":"### TakeSnapshotSuccess 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"TakeSnapshotFailCallback":{"name":"## TakeSnapshotFailCallback","description":"","extends":"","param":"","compatibility":"### TakeSnapshotFailCallback 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"TakeSnapshotFail":{"name":"## TakeSnapshotFail","description":"","extends":"","param":"\n### TakeSnapshotFail 的属性值 @takesnapshotfail-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","compatibility":"### TakeSnapshotFail 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"TakeSnapshotCompleteCallback":{"name":"## TakeSnapshotCompleteCallback","description":"","extends":"","param":"","compatibility":"### TakeSnapshotCompleteCallback 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"DOMRect":{"name":"## DOMRect","description":"一个 DOMRect 代表一个矩形。","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 否 | 0 | - | 矩形原点的x坐标 |\n| y | number | 否 | 0 | - | 矩形原点的y坐标 |\n| width | number | 否 | 0 | - | 矩形的宽 |\n| height | number | 否 | 0 | - | 矩形的高 |\n\n### DOMRect 的属性值 @domrect-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| width | number | 是 | - | - | 矩形的宽 |\n| height | number | 是 | - | - | 矩形的高 |\n| x | number | 是 | - | - | 矩形原点的x坐标 |\n| y | number | 是 | - | - | 矩形原点的y坐标 |\n| left | number | 是 | - | - | 矩形的左坐标值 |\n| right | number | 是 | - | - | 矩形的右坐标值 |\n| top | number | 是 | - | - | 矩形的顶坐标值 |\n| bottom | number | 是 | - | - | 矩形的底坐标值 |\n","compatibility":"### DOMRect 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"DrawableContext":{"name":"## DrawableContext","description":"","extends":"","param":"\n### DrawableContext 的属性值 @drawablecontext-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| font | string | 是 | 10px | - | 设置字体大小 |\n| fillStyle | [string.ColorString](/uts/data-type.md#ide-string) | 是 | #000 (黑色) | - | 设置填充颜色 |\n| lineCap | string | 是 | butt | - | 指定如何绘制每一条线条末端的属性，可选值：`butt`线段末端以方形结束；`round`线段末端以圆形结束；`square`线段末端以方形结束，但是会增加一个一半宽度的矩形区域。 |\n| lineDashOffset | number | 是 | - | - | 设置虚线偏移量 |\n| lineJoin | string | 是 | miter | - | 设置 2 个长度不为 0 的线条相连部分如何连接在一起的属性，可选值：`bevel`斜角；`round`圆角；`miter`尖角。 |\n| lineWidth | number | 是 | 1px | - | 设置线条的宽度 |\n| strokeStyle | [string.ColorString](/uts/data-type.md#ide-string) | 是 | #000 (黑色) | - | 设置边框的颜色 |\n| textAlign | string | 是 | left | - | 设置文本的对齐方式，可取值：`left`左对齐；`center`居中对齐；`right`右对齐。 |\n","methods":{"beginPath":{"name":"#### beginPath() @beginpath","description":"创建一个新的空路径","param":"","returnValue":"","compatibility":"##### beginPath 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"arc":{"name":"#### arc(x, y, radius, startAngle, endAngle, anticlockwise?) @arc","description":"绘制一段弧线","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 圆心的X轴坐标 |\n| y | number | 是 | - | - | 圆心的Y轴坐标 |\n| radius | number | 是 | - | - | 圆弧的半径 |\n| startAngle | number | 是 | - | - | 圆弧的起始点，x 轴方向开始计算，单位为弧度 |\n| endAngle | number | 是 | - | - | 圆弧的终点，单位为弧度 |\n| anticlockwise | boolean \\| null | 否 | true | - | 圆弧绘制方向，true：逆时针绘制，false：顺时针绘制。 | \n","returnValue":"","compatibility":"##### arc 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"moveTo":{"name":"#### moveTo(x, y) @moveto","description":"将一个新的路径的起始点移动到 (x，y) 坐标","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 点的X轴坐标 |\n| y | number | 是 | - | - | 点的Y轴坐标 | \n","returnValue":"","compatibility":"##### moveTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"rect":{"name":"#### rect(x, y, width, height) @rect","description":"创建一个矩形路径","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 矩形起点的X轴坐标 |\n| y | number | 是 | - | - | 矩形起点的Y轴坐标 |\n| width | number | 是 | - | - | 矩形宽度 |\n| height | number | 是 | - | - | 矩形高度 | \n","returnValue":"","compatibility":"##### rect 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"lineTo":{"name":"#### lineTo(x, y) @lineto","description":"将路径的最后一个点连接到 (x，y) 坐标","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 线终点的X轴坐标 |\n| y | number | 是 | - | - | 线终点的Y轴坐标 | \n","returnValue":"","compatibility":"##### lineTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"closePath":{"name":"#### closePath() @closepath","description":"闭合路径，将最后一个点与起点连接起来。如果图形已经封闭，或者只有一个点，那么此方法不会产生任何效果。","param":"","returnValue":"","compatibility":"##### closePath 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"stroke":{"name":"#### stroke() @stroke","description":"绘制当前或已经存在的路径的边框。","param":"","returnValue":"","compatibility":"##### stroke 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"strokeRect":{"name":"#### strokeRect(x, y, width, height) @strokerect","description":"绘制一个矩形框","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 矩形起点的X轴坐标 |\n| y | number | 是 | - | - | 矩形起点的Y轴坐标 |\n| width | number | 是 | - | - | 矩形宽度 |\n| height | number | 是 | - | - | 矩形高度 | \n","returnValue":"","compatibility":"##### strokeRect 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"strokeText":{"name":"#### strokeText(text, x, y) @stroketext","description":"绘制空心字符","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| text | string | 是 | - | - | 要绘制的字符 |\n| x | number | 是 | - | - | 字符开始绘制的X轴坐标 |\n| y | number | 是 | - | - | 字符开始绘制的Y轴坐标 | \n","returnValue":"","compatibility":"##### strokeText 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"fill":{"name":"#### fill(fillRule?) @fill","description":"填充当前或已存在的路径","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| fillRule | string \\| null | 否 | nonzero | - | 填充规则。可取值：`nonzero`非零环绕规则；`evenodd`奇偶环绕规则。 | \n","returnValue":"","compatibility":"##### fill 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"fillRect":{"name":"#### fillRect(x, y, width, height) @fillrect","description":"绘制一个实心矩形","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 矩形起点的X轴坐标 |\n| y | number | 是 | - | - | 矩形起点的Y轴坐标 |\n| width | number | 是 | - | - | 矩形宽度 |\n| height | number | 是 | - | - | 矩形高度 | \n","returnValue":"","compatibility":"##### fillRect 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"fillText":{"name":"#### fillText(text, x, y) @filltext","description":"绘制实心字符","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| text | string | 是 | - | - | 要绘制的字符 |\n| x | number | 是 | - | - | 字符开始绘制的X轴坐标 |\n| y | number | 是 | - | - | 字符开始绘制的Y轴坐标 | \n","returnValue":"","compatibility":"##### fillText 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"reset":{"name":"#### reset() @reset","description":"清空绘制数据","param":"","returnValue":"","compatibility":"##### reset 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"update":{"name":"#### update() @update","description":"将所有绘制内容更新到画布上","param":"","returnValue":"","compatibility":"##### update 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"setLineDash":{"name":"#### setLineDash(segments) @setlinedash","description":"设置虚线样式","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| segments | number[\\] | 是 | - | - | 一组描述交替绘制线段和间距长度的数字。 | \n","returnValue":"","compatibility":"##### setLineDash 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"bezierCurveTo":{"name":"#### bezierCurveTo(cp1x, cp1y, cp2x, cp2y, x, y) @beziercurveto","description":"创建三次方贝塞尔曲线路径","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| cp1x | number | 是 | - | - | 第一个贝塞尔控制点的 x 坐标 |\n| cp1y | number | 是 | - | - | 第一个贝塞尔控制点的 y 坐标 |\n| cp2x | number | 是 | - | - | 第二个贝塞尔控制点的 x 坐标 |\n| cp2y | number | 是 | - | - | 第二个贝塞尔控制点的 y 坐标 |\n| x | number | 是 | - | - | 结束点的 x 坐标 |\n| y | number | 是 | - | - | 结束点的 y 坐标 | \n","returnValue":"","compatibility":"##### bezierCurveTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""}},"compatibility":"### DrawableContext 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/element-draw/element-draw.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/element-draw/element-draw\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n var y = 160\n export default {\n data() {\n return {\n texts: [\n 'HBuilderX，轻巧、极速，极客编辑器',\n 'uni-app x，终极跨平台方案',\n 'uniCloud，js serverless云服务',\n 'uts，大一统语言',\n 'uniMPSdk，让你的App具备小程序能力',\n 'uni-admin，开源、现成的全端管理后台',\n 'uni-id，开源、全端的账户中心',\n 'uni-pay，开源、云端一体、全平台的支付',\n 'uni-ai，聚合ai能力',\n 'uni-cms，开源、云端一体、全平台的内容管理平台',\n 'uni-im，开源、云端一体、全平台的im即时消息',\n 'uni统计，开源、完善、全平台的统计报表',\n '......'\n ] as string[]\n }\n },\n onShow() {\n },\n\n onReady() {\n this.drawText()\n this.drawLines()\n this.drawCircles()\n this.drawStar()\n this.drawhouse()\n this.drawPoint()\n this.drawRect()\n this.drawArcTo()\n },\n onUnload() {\n y = 160\n },\n methods: {\n drawText() {\n let element = uni.getElementById('draw-text-view')!\n let ctx = element.getDrawableContext()!\n let width = element.getBoundingClientRect().width\n ctx.reset()\n ctx.font = \"15px Arial\"\n ctx.textAlign = \"center\"\n for (var i = 0; i < this.texts.length; i++) {\n let value = this.texts[i]\n if (i % 2 == 0) {\n ctx.fillText(value, width / 2, (20 * (i + 1)))\n } else {\n ctx.lineWidth = 0.5\n ctx.strokeText(value, width / 2, (20 * (i + 1)))\n }\n }\n ctx.update()\n },\n drawLines() {\n let ctx = uni.getElementById('draw-line-view')!.getDrawableContext()!\n ctx.reset()\n ctx.lineWidth = 10;\n\n [\"round\", \"bevel\", \"miter\"].forEach((join, i) => {\n ctx.lineJoin = join;\n ctx.beginPath();\n ctx.moveTo(5, 10 + i * 40);\n ctx.lineTo(50, 50 + i * 40);\n ctx.lineTo(90, 10 + i * 40);\n ctx.lineTo(130, 50 + i * 40);\n ctx.lineTo(170, 10 + i * 40);\n ctx.stroke();\n });\n ctx.lineWidth = 1\n var space = 170\n ctx.strokeStyle = '#09f';\n ctx.beginPath();\n ctx.moveTo(10 + space, 10);\n ctx.lineTo(140 + space, 10);\n ctx.moveTo(10 + space, 140);\n ctx.lineTo(140 + space, 140);\n ctx.stroke();\n // Draw lines\n ctx.strokeStyle = 'black';\n ['butt', 'round', 'square'].forEach((lineCap, i) => {\n ctx.lineWidth = 15;\n ctx.lineCap = lineCap;\n ctx.beginPath();\n ctx.moveTo(25 + space + i * 50, 10);\n ctx.lineTo(25 + space + i * 50, 140);\n ctx.stroke();\n });\n ctx.lineWidth = 1;\n this.drawDashedLine([], ctx);\n this.drawDashedLine([2, 2], ctx);\n this.drawDashedLine([10, 10], ctx);\n this.drawDashedLine([20, 5], ctx);\n this.drawDashedLine([15, 3, 3, 3], ctx);\n this.drawDashedLine([20, 3, 3, 3, 3, 3, 3, 3], ctx);\n ctx.lineDashOffset = 18;\n this.drawDashedLine([12, 3, 3], ctx);\n ctx.lineDashOffset = 0\n ctx.setLineDash([0])\n ctx.update()\n },\n drawDashedLine(pattern : Array, ctx : DrawableContext) {\n ctx.beginPath();\n ctx.setLineDash(pattern);\n ctx.moveTo(0, y);\n ctx.lineTo(300, y);\n ctx.stroke();\n y += 15;\n },\n drawCircles() {\n let ctx = uni.getElementById('draw-circle-view')!.getDrawableContext()!\n ctx.reset()\n // Draw shapes\n for (var i = 0; i < 4; i++) {\n for (var j = 0; j < 3; j++) {\n ctx.beginPath();\n var x = 25 + j * 50; // x coordinate\n var y = 25 + i * 50; // y coordinate\n var radius = 20; // Arc radius\n var startAngle = 0; // Starting point on circle\n var endAngle = Math.PI + (Math.PI * j) / 2; // End point on circle\n var clockwise = i % 2 == 0 ? false : true; // clockwise or anticlockwise\n\n ctx.arc(x, y, radius, startAngle, endAngle, clockwise);\n\n if (i > 1) {\n ctx.fill();\n } else {\n ctx.stroke();\n }\n }\n }\n ctx.update()\n },\n\n drawStar() {\n let ctx = uni.getElementById('draw-dash-line')!.getDrawableContext()!\n ctx.reset()\n ctx.beginPath();\n var horn = 5; // 画5个角\n var angle = 360 / horn; // 五个角的度数\n // 两个圆的半径\n var R = 50;\n var r = 20;\n // 坐标\n var x = 100;\n var y = 100;\n for (var i = 0; i < horn; i++) {\n // 角度转弧度：角度/180*Math.PI\n // 外圆顶点坐标\n ctx.lineTo(Math.cos((18 + i * angle) / 180.0 * Math.PI) * R + x, -Math.sin((18 + i * angle) / 180.0 * Math.PI) * R + y);\n // 內圆顶点坐标\n ctx.lineTo(Math.cos((54 + i * angle) / 180.0 * Math.PI) * r + x, -Math.sin((54 + i * angle) / 180.0 * Math.PI) * r + y);\n }\n // closePath：关闭路径，将路径的终点与起点相连\n ctx.closePath();\n ctx.lineWidth = 3;\n ctx.fillStyle = '#E4EF00';\n ctx.strokeStyle = \"red\";\n ctx.fill();\n ctx.stroke();\n\n ctx.lineWidth = 10;\n ctx.beginPath()\n ctx.moveTo(170, 100)\n ctx.lineTo(255, 15)\n ctx.lineTo(340, 100)\n ctx.closePath()\n ctx.fill()\n ctx.strokeStyle = \"blue\"\n ctx.stroke()\n ctx.beginPath()\n ctx.moveTo(170, 145)\n ctx.lineTo(255, 45)\n ctx.lineTo(340, 145)\n ctx.closePath()\n ctx.fill()\n ctx.strokeStyle = \"gray\"\n ctx.stroke()\n // 未设置beginPath，导致上下表现一致，与前端一致\n ctx.moveTo(170, 190)\n ctx.lineTo(255, 90)\n ctx.lineTo(340, 190)\n ctx.closePath()\n ctx.fillStyle = \"orange\"\n ctx.fill()\n ctx.strokeStyle = \"khaki\"\n ctx.stroke()\n ctx.update()\n },\n hex(num : number) : string {\n if (num == 0) {\n return \"00\"\n }\n let hexChars = \"0123456789ABCDEF\";\n let result = \"\";\n while (num > 0) {\n let remainder = Math.floor(num) % 16;\n result = hexChars[remainder] + result;\n num = Math.floor(Math.floor(num) / 16);\n }\n if (result.length == 1) {\n return \"0\" + result\n }\n return result\n },\n drawhouse() {\n let ctx = uni.getElementById('draw-house')!.getDrawableContext()!\n ctx.reset()\n ctx.lineWidth = 10;\n\n // Wall\n ctx.strokeRect(75, 140, 150, 110);\n\n // Door\n ctx.fillRect(130, 190, 40, 60);\n\n // Roof\n ctx.beginPath();\n ctx.moveTo(50, 140);\n ctx.lineTo(150, 60);\n ctx.lineTo(250, 140);\n ctx.closePath();\n ctx.stroke();\n ctx.update()\n },\n drawPoint() {\n let ctx = uni.getElementById('draw-style')!.getDrawableContext()!\n ctx.reset()\n for (let i = 0; i < 6; i++) {\n for (let j = 0; j < 6; j++) {\n ctx.strokeStyle = `rgb(0,${Math.floor(255 - 42.5 * i)},${Math.floor(255 - 42.5 * j)})`;\n ctx.beginPath();\n ctx.arc(12.5 + j * 25, 12.5 + i * 25, 10, 0, Math.PI * 2, true);\n ctx.stroke();\n }\n }\n for (let i = 0; i < 6; i++) {\n for (let j = 0; j < 6; j++) {\n ctx.fillStyle = `rgb(${Math.floor(255 - 42.5 * i)},${Math.floor(255 - 42.5 * j)},0)`;\n ctx.fillRect(180 + j * 25, i * 25, 25, 25);\n }\n }\n ctx.update()\n },\n drawRect() {\n let ctx = uni.getElementById('draw-odd')!.getDrawableContext()!\n ctx.reset()\n // Create path\n ctx.moveTo(30, 90);\n ctx.lineTo(110, 20);\n ctx.lineTo(240, 130);\n ctx.lineTo(60, 130);\n ctx.lineTo(190, 20);\n ctx.lineTo(270, 90);\n ctx.closePath();\n\n // Fill path\n ctx.fillStyle = \"green\";\n ctx.fill(\"evenodd\");\n ctx.update()\n\n },\n drawArcTo() {\n let ctx = uni.getElementById('draw-arcto')!.getDrawableContext()!\n ctx.reset()\n ctx.beginPath();\n ctx.moveTo(50, 20);\n ctx.bezierCurveTo(230, 30, 150, 60, 50, 100);\n ctx.stroke();\n\n ctx.fillStyle = \"blue\";\n // start point\n ctx.fillRect(50, 20, 10, 10);\n // end point\n ctx.fillRect(50, 100, 10, 10);\n\n ctx.fillStyle = \"red\";\n // control point one\n ctx.fillRect(230, 30, 10, 10);\n // control point two\n ctx.fillRect(150, 70, 10, 10);\n ctx.update()\n }\n }\n }\n\n```\n:::"},"UniCallbackWrapper":{"name":"## UniCallbackWrapper","description":"事件回调封装类，用于注销监听函数的形参","extends":"","param":"","compatibility":"### UniCallbackWrapper 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UniEvent":{"name":"## UniEvent","description":"","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件的名称 |\n\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件的名称 |\n| eventInit | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | - | 事件初始参数。支持字段：`bubbles`表明该事件是否冒泡。可选，默认为false；`cancelable`表明该事件是否可以被取消。可选，默认为false。 |\n\n### UniEvent 的属性值 @unievent-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"阻止当前事件的默认行为
","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### UniEvent 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"CustomEvent":{"name":"## CustomEvent","description":"","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | - |\n| detail | T | 是 | - | - | - |\n\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | - |\n| options | any | 是 | - | - | - |\n\n### CustomEvent 的属性值 @customevent-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| detail | T | 是 | - | - | - |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"阻止当前事件的默认行为
","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### CustomEvent 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"MouseEvent":{"name":"## MouseEvent","description":"","extends":"","param":"\n### MouseEvent 的属性值 @mouseevent-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n| x | number | 是 | - | - | 相对于页面可显示区域左边的距离，同`clientX` |\n| y | number | 是 | - | - | 相对于页面可显示区域顶部的距离，同`clientY` |\n| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"阻止当前事件的默认行为
","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### MouseEvent 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"TouchEvent":{"name":"## TouchEvent","description":"","extends":"","param":"\n### TouchEvent 的属性值 @touchevent-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| touches | Array\\<**UniTouch**\\> | 是 | - | - | 当前停留在屏幕中的触摸点信息的数组 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n@| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n@| identifier | number | 是 | - | - | 触摸点的标识符。这个值在这根手指所引发的所有事件中保持一致，直到手指抬起。 |\n@| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n@| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n@| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n@| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n@| force | number \\| null | 否 | - | - | 返回当前触摸点按下的压力大小 |\n| changedTouches | Array\\<**UniTouch**\\> | 是 | - | - | 当前变化的触摸点信息的数组 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n@| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n@| identifier | number | 是 | - | - | 触摸点的标识符。这个值在这根手指所引发的所有事件中保持一致，直到手指抬起。 |\n@| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n@| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n@| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n@| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n@| force | number \\| null | 否 | - | - | 返回当前触摸点按下的压力大小 |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"阻止当前事件的默认行为
","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### TouchEvent 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UniTouch":{"name":"## UniTouch","description":"","extends":"","param":"\n### UniTouch 的属性值 @unitouch-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n| identifier | number | 是 | - | - | 触摸点的标识符。这个值在这根手指所引发的所有事件中保持一致，直到手指抬起。 |\n| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n| force | number \\| null | 否 | - | - | 返回当前触摸点按下的压力大小 |\n","compatibility":"### UniTouch 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"Touch":{"name":"## Touch","description":"","extends":"","param":"\n### Touch 的属性值 @touch-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n| identifier | number | 是 | - | - | 触摸点的标识符。这个值在这根手指所引发的所有事件中保持一致，直到手指抬起。 |\n| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n| force | number \\| null | 否 | - | - | 返回当前触摸点按下的压力大小 |\n","compatibility":"### Touch 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UniCustomEvent":{"name":"## UniCustomEvent","description":"","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | - |\n| detail | T | 是 | - | - | - |\n\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | - |\n| options | any | 是 | - | - | - |\n\n### UniCustomEvent 的属性值 @unicustomevent-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| detail | T | 是 | - | - | - |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"阻止当前事件的默认行为
","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### UniCustomEvent 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UniMouseEvent":{"name":"## UniMouseEvent","description":"","extends":"","param":"\n### UniMouseEvent 的属性值 @unimouseevent-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n| x | number | 是 | - | - | 相对于页面可显示区域左边的距离，同`clientX` |\n| y | number | 是 | - | - | 相对于页面可显示区域顶部的距离，同`clientY` |\n| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"阻止当前事件的默认行为
","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### UniMouseEvent 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UniTouchEvent":{"name":"## UniTouchEvent","description":"","extends":"","param":"\n### UniTouchEvent 的属性值 @unitouchevent-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| touches | Array\\<**UniTouch**\\> | 是 | - | - | 当前停留在屏幕中的触摸点信息的数组 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n@| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n@| identifier | number | 是 | - | - | 触摸点的标识符。这个值在这根手指所引发的所有事件中保持一致，直到手指抬起。 |\n@| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n@| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n@| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n@| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n@| force | number \\| null | 否 | - | - | 返回当前触摸点按下的压力大小 |\n| changedTouches | Array\\<**UniTouch**\\> | 是 | - | - | 当前变化的触摸点信息的数组 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n@| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n@| identifier | number | 是 | - | - | 触摸点的标识符。这个值在这根手指所引发的所有事件中保持一致，直到手指抬起。 |\n@| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n@| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n@| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n@| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n@| force | number \\| null | 否 | - | - | 返回当前触摸点按下的压力大小 |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"阻止当前事件的默认行为
","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### UniTouchEvent 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UniPointerEvent":{"name":"## UniPointerEvent","description":"","extends":"","param":"\n### UniPointerEvent 的属性值 @unipointerevent-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| clientX | number | 是 | - | - | 相对于页面可显示区域左边的距离 |\n| clientY | number | 是 | - | - | 相对于页面可显示区域顶部的距离 |\n| x | number | 是 | - | - | 相对于页面可显示区域左边的距离，同`clientX` |\n| y | number | 是 | - | - | 相对于页面可显示区域顶部的距离，同`clientY` |\n| pageX | number | 是 | - | - | 相对于文档左边的距离 |\n| pageY | number | 是 | - | - | 相对于文档顶部的距离 |\n| screenX | number | 是 | - | - | 相对于屏幕左边距离 |\n| screenY | number | 是 | - | - | 相对于屏幕顶部的距离 |\n| bubbles | boolean | 是 | - | - | 是否冒泡 |\n| cancelable | boolean | 是 | - | - | 是否可以取消 |\n| type | string | 是 | - | - | 事件类型 |\n| target | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| currentTarget | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| timeStamp | number | 是 | - | - | 事件发生时的时间戳 |\n","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"##### stopPropagation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"阻止当前事件的默认行为
","param":"","returnValue":"","compatibility":"##### preventDefault 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |\n","tutorial":""}},"compatibility":"### UniPointerEvent 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"Element":{"name":"## Element","description":"","extends":"","param":"\n### Element 的属性值 @element-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| classList | Array\\ | 是 | - | - | 只读属性 获取当前元素的的 class 属性的动态集合。 |\n| firstChild | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| lastChild | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| parentElement | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| previousSibling | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| nextElementSibling | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 |\n| children | Array\\<[UniElement](/dom/unielement.md)\\> | 是 | - | - | 只读属性 获取当前元素包含的子元素的集合 |\n| tagName | string | 是 | - | - | 只读属性 获取当前元素的标签名 |\n| nodeName | string | 是 | - | - | 只读属性 获取当前元素的元素名称 |\n| dataset | Map\\ | 是 | - | - | 只读属性 获取元素上自定义数据属性（data-*）的集合 |\n| attributes | Map\\ | 是 | - | - | 只读属性 获取元素上所有属性元素的集合 |\n| style | [CSSStyleDeclaration](/dom/cssstyledeclaration.md) | 是 | - | - | 只读属性 获取元素的CSS样式对象 |\n| scrollWidth | number | 是 | - | - | 只读属性 获取可滚动元素内容的总宽度，仅scroll-view、list-view组件支持，其他组件返回视图宽度 |\n| scrollHeight | number | 是 | - | - | 只读属性 获取可滚动元素内容的总高度，仅scroll-view、list-view组件支持，其他组件返回视图高度 |\n| scrollLeft | number | 是 | - | - | 获取或修改元素滚动条到元素左边的距离像素数，仅scroll-view、list-view组件支持。其他组件返回0 |\n| scrollTop | number | 是 | - | - | 获取或修改元素滚动条到元素顶部的距离像素数，仅scroll-view、list-view组件支持。其他组件返回0 |\n| offsetLeft | number | 是 | - | - | 只读属性 元素的左边界偏移值 单位px |\n| offsetTop | number | 是 | - | - | 只读属性 元素的顶部边界偏移值 单位px |\n| offsetWidth | number | 是 | - | - | 只读属性 元素的布局宽度，宽度包含border、padding的数据值 单位px |\n| offsetHeight | number | 是 | - | - | 只读属性 元素的布局高度，高度包含border、padding的数据值 单位px |\n| ext | Map\\ | 是 | - | - | 只读属性 扩展属性 |\n","methods":{"takeSnapshot":{"name":"#### takeSnapshot(options) @takesnapshot","description":"对当前组件进行截图，调用此方法会将当前组件（包含子节点）渲染结果导出成图片。
成功会返回图片对应的临时文件路径，目前默认png格式
","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [TakeSnapshotOptions](#takesnapshotoptions-values) | 是 | - | - | 组件截图的参数对象 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| type | string \\| null | 否 | \"file\" | - | 截图导出类型，目前仅支持 'file' 保存到临时文件目录 |\n@| format | string \\| null | 否 | \"png\" | - | 截图文件格式，目前仅支持 'png' |\n@| success | (res: [TakeSnapshotSuccess](#takesnapshotsuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (res: [TakeSnapshotFail](#takesnapshotfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### TakeSnapshotSuccess 的属性值 @takesnapshotsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tempFilePath | string | 是 | - | - | 截图保存的临时文件路径 |\n\n##### TakeSnapshotFail 的属性值 @takesnapshotfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"##### takeSnapshot 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.93 | 4.11 | x |\n","tutorial":""},"appendChild":{"name":"#### appendChild(aChild) @appendchild","description":"将一个元素添加到指定父元素的子元素列表的末尾处。如果将被插入的元素已经存在于当前文档的文档树中，那么将会它从原先的位置移动到新的位置。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| aChild | [UniElement](/dom/unielement.md) | 是 | - | - | 插入子元素对象 | \n","returnValue":"","compatibility":"##### appendChild 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"insertBefore":{"name":"#### insertBefore(newChild, refChild?) @insertbefore","description":"在参考元素之前插入一个拥有指定父元素的子元素。如果给定的子元素是对文档中现有元素的引用，insertBefore() 会将其从当前位置移动到新位置。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| newChild | [UniElement](/dom/unielement.md) | 是 | - | - | 插入子元素对象 |\n| refChild | [UniElement](/dom/unielement.md) \\| null | 否 | - | - | UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UniElement](/dom/unielement.md) \\| null | 否 |\n \n","compatibility":"##### insertBefore 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"setAttribute":{"name":"#### setAttribute(key, value) @setattribute","description":"设置指定元素上的某个属性值。如果设置的属性已经存在，则更新该属性值；否则使用指定的名称和值添加一个新的属性。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 属性名称 |\n| value | string | 是 | - | - | 属性值域 | \n","returnValue":"","compatibility":"##### setAttribute 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"getAttribute":{"name":"#### getAttribute(key) @getattribute","description":"获取元素指定的属性值，如果指定的属性不存在则返回null。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 属性名称 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| string \\| null | 否 |\n \n","compatibility":"##### getAttribute 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"hasAttribute":{"name":"#### hasAttribute(key) @hasattribute","description":"返回改元素是否包含有指定的属性，属性存在则返回true，否则返回false。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 属性名称 | \n","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n","compatibility":"##### hasAttribute 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"removeAttribute":{"name":"#### removeAttribute(key) @removeattribute","description":"从元素中删除一个属性，如果指定的属性不存在，则不做任何操作，也不会产生错误。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 属性名称 | \n","returnValue":"","compatibility":"##### removeAttribute 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"getBoundingClientRect":{"name":"#### getBoundingClientRect() @getboundingclientrect","description":"获取元素的大小及其相对于窗口的位置信息。","param":"","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| [DOMRect](/dom/domrect.md) |\n \n","compatibility":"##### getBoundingClientRect 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"getDrawableContext":{"name":"#### getDrawableContext() @getdrawablecontext","description":"获取组件的绘制对象，仅uvue页面中的 view 组件支持，其它组件不支持则返回null。","param":"","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [DrawableContext](/dom/drawablecontext.md) \\| null | 否 |\n \n","compatibility":"##### getDrawableContext 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | x |\n","tutorial":""},"addEventListener":{"name":"#### addEventListener(type, callback) @addeventlistener","description":"将指定的监听器注册到元素对象上，当该对象触发指定的事件时，指定的回调函数就会被执行。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件类型 |\n| callback | (event: T) => R | 是 | - | - | 事件监听器 T表示event类型，R表示返回值类型 | \n","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| UniCallbackWrapper |\n \n","compatibility":"##### addEventListener 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"removeEventListener":{"name":"#### removeEventListener(type, callbackWrapper) @removeeventlistener","description":"删除使用 addEventListener 方法添加的事件监听器。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件类型 |\n| callbackWrapper | UniCallbackWrapper | 是 | - | - | 事件监听回调封装类 | \n","returnValue":"","compatibility":"##### removeEventListener 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"removeChild":{"name":"#### removeChild(aChild) @removechild","description":"从元素中删除一个子元素，返回删除的元素。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| aChild | [UniElement](/dom/unielement.md) | 是 | - | - | 被删除子元素对象 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UniElement](/dom/unielement.md) \\| null | 否 |\n \n","compatibility":"##### removeChild 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"remove":{"name":"#### remove() @remove","description":"把元素对象从它所属的 DOM 树中删除。","param":"","returnValue":"","compatibility":"##### remove 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"dispatchEvent":{"name":"#### dispatchEvent(type, value) @dispatchevent","description":"向一个指定的事件目标派发一个 Event，并以合适的顺序（同步地）调用此事件的监听器回调函数。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 事件类型 |\n| value | [UniEvent](/component/common#unievent) | 是 | - | - | 事件返回对象 | \n","returnValue":"","compatibility":"##### dispatchEvent 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"scrollTo":{"name":"#### scrollTo(x, y) @scrollto","description":"使界面滚动到给定元素的指定坐标位置 仅scroll-view、list-view组件支持","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | x轴要滚动到坐标位置(单位px) |\n| y | number | 是 | - | - | y轴要滚动到坐标位置(单位px) | \n","returnValue":"","compatibility":"##### scrollTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"scrollBy":{"name":"#### scrollBy(x, y) @scrollby","description":"使得元素滚动一段特定距离 仅scroll-view、list-view组件支持","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | x轴要滚动的距离(单位px) |\n| y | number | 是 | - | - | y轴要滚动的距离(单位px) | \n","returnValue":"","compatibility":"##### scrollBy 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"querySelector":{"name":"#### querySelector(selector) @queryselector","description":"返回文档中与指定选择器或选择器组匹配的第一个 Element对象。如果找不到匹配项，则返回null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| selector | [string.cssSelectorString](/uts/data-type.md#ide-string) | 是 | - | - | CSS 选择器字符串 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UniElement](/dom/unielement.md) \\| null | 否 |\n \n","compatibility":"##### querySelector 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"querySelectorAll":{"name":"#### querySelectorAll(selector) @queryselectorall","description":"返回与指定的选择器组匹配的文档中的元素列表","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| selector | [string.cssSelectorString](/uts/data-type.md#ide-string) | 是 | - | - | CSS 选择器字符串 | \n","returnValue":"##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Array\\<[UniElement](/dom/unielement.md)\\> \\| null | 否 |\n \n","compatibility":"##### querySelectorAll 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"focus":{"name":"#### focus() @focus","description":"使元素获取焦点 仅input、Textarea组件支持","param":"","returnValue":"","compatibility":"##### focus 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"blur":{"name":"#### blur() @blur","description":"使元素丢失焦点 仅input、Textarea组件支持","param":"","returnValue":"","compatibility":"##### blur 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""}},"compatibility":"### Element 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"UniResizeObserver":{"name":"## UniResizeObserver","description":"用于监视 UniElement 元素的大小变化。它可以观察一个或多个","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (entries: Array\\<**UniResizeObserverEntry**\\>) => void | 是 | - | - | 每当监视的元素调整大小时，回调该函数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| borderBoxSize | Array\\<**UniBorderBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素带有边框box大小的数组。 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| blockSize | number | 是 | - | - | 只读属性，被监视元素含边框box的高度 |\n@@| inlineSize | number | 是 | - | - | 只读属性，被监视元素含边框box的宽度 |\n@| contentBoxSize | Array\\<**UniContentBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素内容box大小的数组。 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| blockSize | number | 是 | - | - | 只读属性，被监视元素内容box的高度 |\n@@| inlineSize | number | 是 | - | - | 只读属性，被监视元素内容box的宽度 |\n@| devicePixelContentBoxSize | Array\\<**UniDevicePixelContentBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素内容box设备像素大小的数组。 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| blockSize | number | 是 | - | - | 只读属性，被监视元素内容box的设备像素高度 |\n@@| inlineSize | number | 是 | - | - | 只读属性，被监视元素内容box的设备像素宽度 |\n@| contentRect | [DOMRect](/dom/domrect.md) | 是 | - | - | 只读属性 包含被监视元素大小的DOMRect |\n@| target | [UniElement](/dom/unielement.md) | 是 | - | - | 只读属性 被监视的 UniElement |\n\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (entries: Array\\<**UniResizeObserverEntry**\\>, observer: [UniResizeObserver](/dom/uniresizeobserver.md)) => void | 是 | - | - | 每当监视的元素调整大小时，回调该函数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| borderBoxSize | Array\\<**UniBorderBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素带有边框box大小的数组。 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| blockSize | number | 是 | - | - | 只读属性，被监视元素含边框box的高度 |\n@@| inlineSize | number | 是 | - | - | 只读属性，被监视元素含边框box的宽度 |\n@| contentBoxSize | Array\\<**UniContentBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素内容box大小的数组。 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| blockSize | number | 是 | - | - | 只读属性，被监视元素内容box的高度 |\n@@| inlineSize | number | 是 | - | - | 只读属性，被监视元素内容box的宽度 |\n@| devicePixelContentBoxSize | Array\\<**UniDevicePixelContentBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素内容box设备像素大小的数组。 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| blockSize | number | 是 | - | - | 只读属性，被监视元素内容box的设备像素高度 |\n@@| inlineSize | number | 是 | - | - | 只读属性，被监视元素内容box的设备像素宽度 |\n@| contentRect | [DOMRect](/dom/domrect.md) | 是 | - | - | 只读属性 包含被监视元素大小的DOMRect |\n@| target | [UniElement](/dom/unielement.md) | 是 | - | - | 只读属性 被监视的 UniElement |\n","methods":{"disconnect":{"name":"#### disconnect() @disconnect","description":"取消所有的对 UniElement 目标的监视","param":"","returnValue":"","compatibility":"##### disconnect 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"observe":{"name":"#### observe(target) @observe","description":"监视指定 UniElement 大小变化","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| target | [UniElement](/dom/unielement.md) | 是 | - | - | 被监视的 UniElement | \n","returnValue":"","compatibility":"##### observe 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""},"unobserve":{"name":"#### unobserve(target) @unobserve","description":"结束对指定的 UniElement 的监视","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| target | [UniElement](/dom/unielement.md) | 是 | - | - | 取消监视的 UniElement | \n","returnValue":"","compatibility":"##### unobserve 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":""}},"compatibility":"### UniResizeObserver 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/resize-observer/resize-observer.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/resize-observer/resize-observer\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n outBoxSizeInfo: \"\",\r\n innerBoxSizeInfo: \"\",\r\n offset: 2,\r\n boxDisplay: false,\r\n outBoxElement: null as UniElement | null,\r\n innerBoxElement: null as UniElement | null,\r\n resizeObserver: null as UniResizeObserver | null,\r\n outBoxElementOnResize: false\r\n }\r\n },\r\n onBackPress() : boolean {\r\n if (this.resizeObserver != null) {\r\n this.resizeObserver!.disconnect()\r\n }\r\n return false\r\n },\r\n onReady() {\r\n if (this.resizeObserver == null) {\r\n this.resizeObserver = new UniResizeObserver((entries : Array) => {\r\n\r\n entries.forEach(entry => {\r\n if (entry.target == this.outBoxElement) {\r\n this.outBoxSizeInfo = this.analysisResizeObserverEntry(entry)\r\n this.outBoxElementOnResize = true\r\n } else if (entry.target == this.innerBoxElement) {\r\n this.innerBoxSizeInfo = this.analysisResizeObserverEntry(entry)\r\n }\r\n })\r\n })\r\n this.outBoxElement = uni.getElementById(\"outBox\")\r\n if (this.outBoxElement != null) {\r\n this.resizeObserver!.observe(this.outBoxElement!)\r\n }\r\n this.innerBoxElement = uni.getElementById(\"innerBox\")\r\n if (this.innerBoxElement != null) {\r\n this.resizeObserver!.observe(this.innerBoxElement!)\r\n }\r\n this.boxDisplay = true\r\n }\r\n },\r\n methods: {\r\n innerBoxClick() {\r\n if (this.innerBoxElement != null) {\r\n this.innerBoxElement!.style.setProperty(\"width\", this.innerBoxElement!.offsetWidth + this.offset + 'px')\r\n this.innerBoxElement!.style.setProperty(\"height\", this.innerBoxElement!.offsetWidth + this.offset + 'px')\r\n }\r\n },\r\n outBoxClick() {\r\n if (this.outBoxElement != null) {\r\n this.outBoxElement!.style.setProperty(\"width\", this.outBoxElement!.offsetWidth + this.offset + 'px')\r\n this.outBoxElement!.style.setProperty(\"height\", this.outBoxElement!.offsetWidth + this.offset + 'px')\r\n }\r\n },\r\n revertBoxSize() {\r\n if (this.outBoxElement != null) {\r\n this.outBoxElement!.style.setProperty(\"width\", \"140px\")\r\n this.outBoxElement!.style.setProperty(\"height\", \"140px\")\r\n }\r\n if (this.innerBoxElement != null) {\r\n this.innerBoxElement!.style.setProperty(\"width\", \"80px\")\r\n this.innerBoxElement!.style.setProperty(\"height\", \"80px\")\r\n }\r\n },\r\n //自动化测试专用\r\n setOutBoxMarginLeft(value : string) {\r\n if (this.outBoxElement != null) {\r\n this.outBoxElementOnResize = false\r\n this.outBoxElement!.style.setProperty(\"margin-left\", value)\r\n }\r\n },\r\n toggleDisplay() {\r\n this.boxDisplay = !this.boxDisplay\r\n },\r\n analysisResizeObserverEntry(entry : UniResizeObserverEntry) : string {\r\n const contentBoxSize = entry.contentBoxSize[0]\r\n const borderBoxSize = entry.borderBoxSize[0]\r\n const devicePixelContentBoxSize = entry.devicePixelContentBoxSize[0]\r\n return \"borderBoxSize: \\n{blockSize:\" + borderBoxSize.blockSize + \", inlineSize:\" + borderBoxSize.inlineSize + \"}\\n\" +\r\n \"contentBoxSize: \\n{blockSize:\" + contentBoxSize.blockSize + \", inlineSize:\" + contentBoxSize.inlineSize + \"}\\n\" +\r\n \"devicePixelContentBoxSize: \\n{blockSize:\" + devicePixelContentBoxSize.blockSize + \", inlineSize:\" + devicePixelContentBoxSize.inlineSize + \"}\\n\" +\r\n \"contentRect: \\n{x:\" + entry.contentRect.x + \", y:\" + entry.contentRect.y + \", width:\" + entry.contentRect.width + \", height:\" + entry.contentRect.height + \"}\"\r\n },\n cancelListen(){\n // this.resizeObserver?.unobserve()\n this.resizeObserver!.unobserve(this.outBoxElement!)\n this.resizeObserver!.unobserve(this.innerBoxElement!)\n },\n goOnListen(){\n this.resizeObserver!.observe(this.outBoxElement!)\n this.resizeObserver!.observe(this.innerBoxElement!)\n }\r\n }\r\n }\r\n\n```\n:::"},"UniResizeObserverEntry":{"name":"## UniResizeObserverEntry","description":"UniResizeObserverEntry 接口是传递给 UniResizeObserver() 构造函数中的回调函数参数的对象","extends":"","param":"\n### UniResizeObserverEntry 的属性值 @uniresizeobserverentry-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| borderBoxSize | Array\\<**UniBorderBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素带有边框box大小的数组。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| blockSize | number | 是 | - | - | 只读属性，被监视元素含边框box的高度 |\n@| inlineSize | number | 是 | - | - | 只读属性，被监视元素含边框box的宽度 |\n| contentBoxSize | Array\\<**UniContentBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素内容box大小的数组。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| blockSize | number | 是 | - | - | 只读属性，被监视元素内容box的高度 |\n@| inlineSize | number | 是 | - | - | 只读属性，被监视元素内容box的宽度 |\n| devicePixelContentBoxSize | Array\\<**UniDevicePixelContentBoxSize**\\> | 是 | - | | 只读属性 包含被监视的元素内容box设备像素大小的数组。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| blockSize | number | 是 | - | - | 只读属性，被监视元素内容box的设备像素高度 |\n@| inlineSize | number | 是 | - | - | 只读属性，被监视元素内容box的设备像素宽度 |\n| contentRect | [DOMRect](/dom/domrect.md) | 是 | - | - | 只读属性 包含被监视元素大小的DOMRect |\n| target | [UniElement](/dom/unielement.md) | 是 | - | - | 只读属性 被监视的 UniElement |\n","compatibility":"### UniResizeObserverEntry 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |"},"UniBorderBoxSize":{"name":"## UniBorderBoxSize","description":"被监视的元素带有边框box的大小","extends":"","param":"\n### UniBorderBoxSize 的属性值 @uniborderboxsize-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| blockSize | number | 是 | - | - | 只读属性，被监视元素含边框box的高度 |\n| inlineSize | number | 是 | - | - | 只读属性，被监视元素含边框box的宽度 |\n","compatibility":"### UniBorderBoxSize 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |"},"UniContentBoxSize":{"name":"## UniContentBoxSize","description":"被监视的元素内容box的大小","extends":"","param":"\n### UniContentBoxSize 的属性值 @unicontentboxsize-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| blockSize | number | 是 | - | - | 只读属性，被监视元素内容box的高度 |\n| inlineSize | number | 是 | - | - | 只读属性，被监视元素内容box的宽度 |\n","compatibility":"### UniContentBoxSize 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |"},"UniDevicePixelContentBoxSize":{"name":"## UniDevicePixelContentBoxSize","description":"被监视的元素内容box的设备像素大小","extends":"","param":"\n### UniDevicePixelContentBoxSize 的属性值 @unidevicepixelcontentboxsize-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| blockSize | number | 是 | - | - | 只读属性，被监视元素内容box的设备像素高度 |\n| inlineSize | number | 是 | - | - | 只读属性，被监视元素内容box的设备像素宽度 |\n","compatibility":"### UniDevicePixelContentBoxSize 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |"},"UniError":{"name":"## UniError","description":"uni api统一错误信息对象 ","extends":"","param":"\n### 构造函数\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| message | string | 是 | - | - | 统一错误描述信息 |\n\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| message | string | 是 | - | - | 统一错误描述信息 |\n| options | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | - | 源错误对象，原始错误对象应该包含在 options.cause 属性中 |\n\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| errCode | number | 是 | - | - | 统一错误码 |\n| errMsg | string | 是 | - | - | 统一错误描述信息 |\n\n### UniError 的属性值 @unierror-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| errCode | number | 是 | - | - | 统一错误码 |\n| errMsg | string | 是 | - | - | 统一错误描述信息 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | UTS错误信息对象 |\n| name | string | 是 | - | - | - |\n| message | string | 是 | - | - | - |\n","compatibility":"### UniError 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"Error":{"name":"## Error","description":"UTS错误信息对象","extends":"","param":"\n### 构造函数\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| message | string | 是 | - | - | - |\n\n### 构造函数\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| message | string | 是 | - | - | - |\n| options | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | - | - |\n\n### Error 的属性值 @error-values\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - |\n| message | string | 是 | - | - | - |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | UTS错误信息对象 |\n","compatibility":"### Error 兼容性 \n | Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |"},"general-attribute":{"name":"组件公共属性","description":"","attribute":"| 名称 | 类型 | 描述 |\n| :- | :- | :- |\n| id | string(string.IDString) | 组件的唯一标识，一般用于获取组件上下文对象 |\n| style | string | 组件的内联样式，可以动态设置的内联样式 |\n| class | string(string.ClassString) | 组件的样式类，在对应的 css 中定义的样式类 |\n| ref | string | vue中组件的唯一标识，用来给子组件注册引用信息 |\n| data-* | any | 自定义属性，组件上触发的事件时，会发送给事件处理函数 |\n| android-* | any | App-Android平台专有属性，详见[App-Android平台专有属性](https://doc.dcloud.net.cn/uni-app-x/component/common.html#attribute-android)章节 |","compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| id | 3.9 | 4.11 | 4.0 |\n| style | 3.9 | 4.11 | 4.0 |\n| class | 3.9 | 4.11 | 4.0 |\n| ref | 3.9 | 4.11 | 4.0 |\n| data-* | 3.9 | 4.11 | 4.0 |\n| android-* | 3.9 | x | 4.0 |","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/component/general-attribute/general-attribute.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/component/general-attribute/general-attribute\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\nexport default {\n data() {\n return {\n title: 'general-attribute',\n generalId: 'general-id',\n generalClass: 'general-class',\n generalName: 'general-name',\n generalTitle: 'general-title',\n generalData: 'general-data',\n generalStyle: 'background-color: aqua',\n validateGeneralAttrText: '验证基础属性',\n hoverClass: 'hover-class',\n validateViewAttrText: '验证 view 属性',\n changeHeightByRefText: '通过 ref 修改高度',\n }\n },\n methods: {\n validateGeneralAttributes() {\n const generalTarget = this.$refs['general-target'] as UniElement\n const generalId = generalTarget.getAttribute('id')\n if (generalId != this.generalId) {\n this.validateGeneralAttrText = '基础属性 id 验证失败'\n return\n }\n // #ifdef APP\n if (!generalTarget.classList.includes('general-class')) {\n // #endif\n // #ifdef WEB\n if (!Array.from(generalTarget.classList).includes('general-class')) {\n // #endif\n this.validateGeneralAttrText = '基础属性 class 验证失败'\n return\n }\n const generalName = generalTarget.getAttribute('name')\n if (generalName != this.generalName) {\n this.validateGeneralAttrText = '基础属性 name 验证失败'\n return\n }\n const generalTitle = generalTarget.getAttribute('title')\n if (generalTitle != this.generalTitle) {\n this.validateGeneralAttrText = '基础属性 title 验证失败'\n return\n }\n const generalData = generalTarget.getAttribute('data-test')\n if (generalData != this.generalData) {\n this.validateGeneralAttrText = '基础属性 data-test 验证失败'\n return\n }\n this.validateGeneralAttrText = '基础属性验证成功'\n },\n changeHeight(){\n const generalTarget = this.$refs['general-target'] as UniElement\n this.changeHeightByRefText = '已通过 ref 修改高度'\n generalTarget.style.setProperty('height', '200px')\n }\n },\n}\n\n```\n:::"},"general-event":{"name":"组件公共事件","description":"","attribute":"| 名称 | 类型 | 描述 |\n| :- | :- | :- |\n| @click | (event: [UniPointerEvent](/component/common#unipointerevent)) => void | 手指触摸后马上离开。与tap相同，（推荐使用tap事件代替），冒泡事件 |\n| @mousedown | (event: [UniMouseEvent](/component/common#unimouseevent)) => void | 鼠标在元素上点击后触发 |\n| @mousemove | (event: [UniMouseEvent](/component/common#unimouseevent)) => void | 鼠标在元素上移动时触发 |\n| @mouseup | (event: [UniMouseEvent](/component/common#unimouseevent)) => void | 鼠标主按钮在元素上松开时触发 |\n| @touchstart | (event: [UniTouchEvent](/component/common#unitouchevent)) => void | 手指触摸动作开始，冒泡事件，event.type 值为 touchstart |\n| @touchmove | (event: [UniTouchEvent](/component/common#unitouchevent)) => void | 手指触摸后移动，冒泡事件，event.type 值为 touchmove |\n| @touchcancel | (event: [UniTouchEvent](/component/common#unitouchevent)) => void | 手指触摸动作被打断，如来电提醒，弹窗，冒泡事件，event.type 值为 touchcancel |\n| @touchend | (event: [UniTouchEvent](/component/common#unitouchevent)) => void | 手指触摸动作结束，冒泡事件，event.type 值为 touchend |\n| @tap | (event: [UniPointerEvent](/component/common#unipointerevent)) => void | 手指触摸后马上离开，冒泡事件 |\n| @longpress | (event: [UniTouchEvent](/component/common#unitouchevent)) => void | 如果一个组件被绑定了 longpress 事件，那么当用户手指触摸后，超过350ms再离开会触发，冒泡事件 |\n| @longtap | (event: [UniTouchEvent](/component/common#unitouchevent)) => void | 手指触摸后，超过350ms再离开（推荐使用 longpress 事件代替） |\n| @transitionend | (event: [UniEvent](/component/common#unievent)) => void | transition 效果结束时触发 |","compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| @click | 3.9 | 4.11 | 4.0 |\n| @mousedown | x | x | 4.0 |\n| @mousemove | x | x | 4.0 |\n| @mouseup | x | x | 4.0 |\n| @touchstart | 3.9 | 4.11 | 4.0 |\n| @touchmove | 3.9 | 4.11 | 4.0 |\n| @touchcancel | 3.9 | 4.11 | 4.0 |\n| @touchend | 3.9 | 4.11 | 4.0 |\n| @tap | 3.9 | 4.11 | 4.0 |\n| @longpress | 3.9 | 4.11 | 4.0 |\n| @longtap | 3.9 | 4.11 | 4.0 |\n| @transitionend | 3.93 | 4.11 | 4.0 |","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/component/general-event/general-event.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/component/general-event/general-event\n>Template\n```vue\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: 'general-event',\n onTouchStartTime: 0,\n touchStartEvent: null as TouchEvent | null,\n touchCancelEvent: null as TouchEvent | null,\n onTouchMoveTime: 0,\n touchMoveEvent: null as TouchEvent | null,\n onTouchEndTime: 0,\n longPressEvent: null as TouchEvent | null,\n touchEndEvent: null as TouchEvent | null,\n onTapTime: 0,\n tapEvent: null as PointerEvent | null,\n onClickTime: 0,\n clickEvent: null as PointerEvent | null,\n onLongPressTime: 0,\n }\n },\n methods: {\n onTouchStart(e : TouchEvent) {\n this.touchStartEvent = e\n this.onTouchStartTime = Date.now()\n console.log('onTouchStart')\n },\n onTouchCancel(e : TouchEvent) {\n this.touchCancelEvent = e\n console.log('onTouchCancel')\n },\n onTouchMove(e : TouchEvent) {\n this.touchMoveEvent = e\n this.onTouchMoveTime = Date.now()\n console.log('onTouchMove')\n },\n onLongPress(e : TouchEvent) {\n this.longPressEvent = e\n this.onLongPressTime = Date.now()\n console.log('onLongPress')\n },\n onTouchEnd(e : TouchEvent) {\n this.touchEndEvent = e\n this.onTouchEndTime = Date.now()\n console.log('onTouchEnd')\n },\n onTap(e : PointerEvent) {\n this.tapEvent = e\n this.onTapTime = Date.now()\n console.log('onTap')\n },\n onClick(e : PointerEvent) {\n this.clickEvent = e\n this.onClickTime = Date.now()\n console.log('onClick')\n },\n },\n }\n\n```\n:::"}} \ No newline at end of file diff --git a/docs/.vuepress/utils/utsApiJson.json b/docs/.vuepress/utils/utsApiJson.json index f45b0eee5a24987190352da7c9df7c19ff437e00..815d2f77572ea85b6ce089d122205ac2b359ad5c 100644 --- a/docs/.vuepress/utils/utsApiJson.json +++ b/docs/.vuepress/utils/utsApiJson.json @@ -1 +1 @@ -{"getApp":{"name":"## getApp() @getapp","description":"\n`getApp()` 函数用于获取当前应用实例，可通过应用实例调用 App.uvue methods 中定义的方法。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n","compatibility":"### getApp 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/tutorial/page.html#getapp)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.global.get-app)\n"},"get-app":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-app/get-app.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-app/get-app\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { state, setLifeCycleNum } from '@/store/index.uts'\r\n\r\n type MyGlobalData = {\r\n str : string,\r\n num : number,\r\n bool : boolean,\r\n obj : UTSJSONObject,\r\n null : string | null,\r\n arr : number[],\r\n mySet : string[],\r\n myMap : UTSJSONObject,\r\n func : () => string\r\n }\r\n\r\n export default {\r\n data() {\r\n return {\r\n originGlobalData: {\r\n str: '',\r\n num: 0,\r\n bool: false,\r\n obj: {\r\n str: '',\r\n num: 0,\r\n bool: false\r\n } as UTSJSONObject,\r\n null: null,\r\n arr: [] as number[],\r\n mySet: [] as string[],\r\n myMap: {},\r\n func: () : string => ''\r\n } as MyGlobalData,\r\n originGlobalDataFuncRes: '',\r\n newGlobalData: {\r\n str: '',\r\n num: 0,\r\n bool: false,\r\n obj: {\r\n str: '',\r\n num: 0,\r\n bool: false\r\n } as UTSJSONObject,\r\n null: null,\r\n arr: [] as number[],\r\n mySet: [] as string[],\r\n myMap: {},\r\n func: () : string => ''\r\n } as MyGlobalData,\r\n newGlobalDataFuncRes: '',\r\n lifeCycleNum: 0,\r\n }\r\n },\r\n onReady() {\r\n this.lifeCycleNum = state.lifeCycleNum\r\n },\r\n methods: {\r\n getGlobalData() {\r\n const app = getApp()\r\n\r\n this.originGlobalData.str = app.globalData.str\r\n this.originGlobalData.num = app.globalData.num\r\n this.originGlobalData.bool = app.globalData.bool\r\n this.originGlobalData.obj = app.globalData.obj\r\n this.originGlobalData.null = app.globalData.null\r\n this.originGlobalData.arr = app.globalData.arr\r\n app.globalData.mySet.forEach((value : string) => {\r\n this.originGlobalData.mySet.push(value)\r\n })\r\n app.globalData.myMap.forEach((value : any, key : string) => {\r\n this.originGlobalData.myMap[key] = value\r\n })\r\n this.originGlobalData.func = app.globalData.func\r\n this.originGlobalDataFuncRes = this.originGlobalData.func()\r\n },\r\n setGlobalData() {\r\n const app = getApp()\r\n\r\n app.globalData.str = 'new globalData str'\r\n app.globalData.num = 100\r\n app.globalData.bool = true\r\n app.globalData.obj = {\r\n str: 'new globalData obj str',\r\n num: 200,\r\n bool: true\r\n }\r\n app.globalData.null = 'not null'\r\n app.globalData.arr = [1, 2, 3]\r\n app.globalData.mySet = new Set(['a', 'b', 'c'])\r\n app.globalData.myMap = new Map([\r\n ['a', 1],\r\n ['b', 2],\r\n ['c', 3]\r\n ])\r\n app.globalData.func = () : string => {\r\n return 'new globalData func'\r\n }\r\n\r\n this.newGlobalData.str = app.globalData.str\r\n this.newGlobalData.num = app.globalData.num\r\n this.newGlobalData.bool = app.globalData.bool\r\n this.newGlobalData.obj = app.globalData.obj\r\n this.newGlobalData.null = app.globalData.null\r\n this.newGlobalData.arr = app.globalData.arr\r\n app.globalData.mySet.forEach((value : string) => {\r\n this.newGlobalData.mySet.push(value)\r\n })\r\n app.globalData.myMap.forEach((value : any, key : string) => {\r\n this.newGlobalData.myMap[key] = value\r\n })\r\n this.newGlobalData.func = app.globalData.func\r\n this.newGlobalDataFuncRes = this.newGlobalData.func()\r\n },\r\n _increasetLifeCycleNum: function () {\r\n const app = getApp()\r\n app.increasetLifeCycleNum()\r\n this.lifeCycleNum = state.lifeCycleNum\r\n },\r\n // 自动化测试\r\n setLifeCycleNum(num : number) {\r\n setLifeCycleNum(num)\r\n }\r\n },\r\n }\r\n\n```\n:::"},"getCurrentPages":{"name":"## getCurrentPages() @getcurrentpages","description":"\n`getCurrentPages()` 函数用于获取当前页面栈的实例，以数组形式按栈的顺序给出，数组中的元素为页面实例，第一个元素为首页，最后一个元素为当前页面。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[Page](#page-values)\\> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| route | string | 是 | - | - | 页面的路由地址 |\n@| options | Map\\ | 是 | - | - | 页面的路由参数信息，目前web端options类型为Object，后续可能会调整 |\n#### Page 的方法 @page-values \n\n#### $getPageStyle() @$getpagestyle\n\n获取当前页面样式 \\\n包含 pages.json 页面下的 style 节点属性和根节点 globalStyle 属性\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) |\n \n\n##### $getPageStyle 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | 4.13 | 4.13 |\n\n\n##### 参见\n- [$getPageStyle](https://doc.dcloud.net.cn/uni-app-x/api/get-current-pages.html#getPageStyle)\n\n#### $setPageStyle(style) @$setpagestyle\n\n设置当前页面样式 \\\n支持 pages.json 页面下的 style 节点属性和根节点 globalStyle 属性\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| style | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | - | 如果属性名存在，且类型为UTSJSONObject返回对应的结果，不存在返回null | \n\n\n##### $setPageStyle 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | 4.13 | 4.13 |\n\n\n##### 参见\n- [$setPageStyle](https://doc.dcloud.net.cn/uni-app-x/api/get-current-pages.html#setPageStyle)\n \n","compatibility":"### getCurrentPages 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/tutorial/page.html#getcurrentpages)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.global.get-current-pages)\n"},"get-current-pages":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-current-pages/get-current-pages.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-current-pages/get-current-pages\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { PageStyleItem, PageStyleArray } from './page-style.uts';\r\n\r\n class Page {\r\n constructor(public route : string) {\r\n }\r\n }\r\n\r\n export default {\r\n data() {\r\n return {\r\n checked: false,\r\n pages: [] as Page[],\r\n PageStyleArray: PageStyleArray as PageStyleItem[],\r\n currentPageStyle: {} as UTSJSONObject,\r\n }\r\n },\r\n computed: {\r\n pageStyleText() : string {\r\n return JSON.stringify(this.currentPageStyle)\r\n }\r\n },\r\n onLoad() {\r\n this.getPageStyle();\r\n },\r\n onPullDownRefresh() {\r\n setTimeout(() => {\r\n uni.stopPullDownRefresh()\r\n }, 2000)\r\n },\r\n methods: {\r\n startPullDownRefresh() {\r\n uni.startPullDownRefresh()\r\n },\r\n _getCurrentPages: function () {\r\n this.pages.length = 0\r\n const pages = getCurrentPages()\r\n this.pages.push(new Page(pages[0].route))\r\n if (this.pages[0].route.includes('/tabBar/')) {\r\n this.checked = true\r\n }\r\n for (let i = 1; i < pages.length; i++) {\r\n this.pages.push(new Page(pages[i].route))\r\n if (pages[i].route.includes('/tabBar/')) {\r\n this.checked = false\r\n }\r\n }\r\n },\r\n /// get-set-page-style\r\n radioChange(key : string, e : RadioGroupChangeEvent) {\r\n this.setStyleValue(key, e.detail.value);\r\n },\r\n sliderChange(key : string, e : UniSliderChangeEvent) {\r\n this.setStyleValue(key, e.detail.value);\r\n },\r\n switchChange(key : string, e : UniSwitchChangeEvent) {\r\n this.setStyleValue(key, e.detail.value);\r\n },\r\n setStyleValue(key : string, value : any) {\r\n const style = {}\r\n style[key] = value\r\n this.setPageStyle(style)\r\n this.getPageStyle()\r\n },\r\n getPageStyle() : UTSJSONObject {\r\n const pages = getCurrentPages();\r\n const currentPage = pages[pages.length - 1];\r\n this.currentPageStyle = currentPage.$getPageStyle()\r\n return this.currentPageStyle;\r\n },\r\n setPageStyle(style : UTSJSONObject) {\r\n console.log('setPageStyle:', style);\r\n const pages = getCurrentPages();\r\n const currentPage = pages[pages.length - 1];\r\n currentPage.$setPageStyle(style);\r\n },\r\n // getCurrentPage(): Page {\r\n // const pages = getCurrentPages();\r\n // const currentPage = pages[pages.length - 1];\r\n // return currentPage;\r\n // }\r\n },\r\n }\r\n\n```\n:::"},"$on":{"name":"## uni.$on(eventName, callback) @$on","description":"\n监听自定义事件。事件可以由 uni.$emit 触发。回调函数会接收 uni.$emit 传递的参数。\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| eventName | string | 是 | - | - | - |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"","compatibility":"### $on 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [$on](https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#on)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.event-bus.$on)\n"},"$once":{"name":"## uni.$once(eventName, callback) @$once","description":"\n监听一个自定义事件。事件只触发一次，在第一次触发之后移除事件监听器。\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| eventName | string | 是 | - | - | - |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"","compatibility":"### $once 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [$once](https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#once)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.event-bus.$once)\n"},"$off":{"name":"## uni.$off(eventName, callback?) @$off","description":"\n移除自定义事件监听器。如果提供了事件名和回调，则只移除这个回调的监听器。\n4.13+ 开始支持第二个参数为可选，如果仅提供事件名，则移除该事件的所有监听器。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| eventName | string | 是 | - | - | - |\n| callback | () => void \\| null | 否 | - | - | | \n","returnValue":"","compatibility":"### $off 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [$off](https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#off)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.event-bus.$off)\n"},"$emit":{"name":"## uni.$emit(eventName, args?) @$emit","description":"\n触发自定义事件，附加的参数会传递给事件监听器。\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| eventName | string | 是 | - | - | - |\n| args | any \\| null | 否 | - | - | | \n","returnValue":"","compatibility":"### $emit 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [$emit](https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.event-bus.$emit)\n"},"event-bus":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/event-bus/event-bus.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/event-bus/event-bus\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n log: [] as string[],\r\n }\r\n },\r\n methods: {\r\n fn(res : string) {\r\n this.log.push(res)\r\n },\n fn2(res : string) {\n this.log.push(res)\n },\r\n on() {\r\n uni.$on('test', this.fn)\r\n },\n on2() {\n uni.$on('test', this.fn2)\n },\r\n once() {\r\n uni.$once('test', this.fn)\r\n },\r\n off() {\r\n uni.$off('test', this.fn)\r\n },\n offAll() {\n uni.$off('test')\n },\r\n emit() {\r\n uni.$emit('test', 'msg:' + Date.now())\r\n },\r\n clear() {\r\n this.log.length = 0\r\n },\r\n },\r\n }\r\n\n```\n:::"},"addInterceptor":{"name":"## uni.addInterceptor(name, interceptor) @addinterceptor","description":"\n添加拦截器","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | 需要拦截的 API 名称 |\n| interceptor | Interceptor | 是 | - | - | 拦截器 | \n","returnValue":"","compatibility":"### addInterceptor 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.97 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.interceptor.addInterceptor)\n"},"removeInterceptor":{"name":"## uni.removeInterceptor(name, interceptor?) @removeinterceptor","description":"\n删除拦截器","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | 需要删除拦截器的 API 名称 |\n| interceptor | Interceptor \\| null | 否 | - | - | 拦截器 | \n","returnValue":"","compatibility":"### removeInterceptor 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.97 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.interceptor.removeInterceptor)\n"},"interceptor":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/interceptor/interceptor.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/interceptor/interceptor\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n const interceptor = {\r\n invoke: function (options : NavigateToOptions) {\r\n console.log('拦截 navigateTo 接口传入参数为：', options)\r\n const url = './page2'\r\n uni.showToast({\r\n title: `重定向到页面:${url}`\r\n })\r\n options.url = url\r\n },\r\n success: function (res : NavigateBackSuccess) {\r\n console.log('拦截 navigateTo 接口 success 返回参数为：', res)\r\n },\r\n fail: function (err : NavigateToFail) {\r\n console.log('拦截 navigateTo 接口 fail 返回参数为：', err)\r\n },\r\n complete: function (res : NavigateToComplete) {\r\n console.log('拦截 navigateTo 接口 complete 返回参数为：', res)\r\n }\r\n } as Interceptor\r\n export default {\r\n data() {\r\n return {\r\n msg: \"会跳转到测试页面1\"\r\n }\r\n },\r\n beforeUnmount() {\r\n // 移除 navigateTo 所有拦截器\r\n uni.removeInterceptor('navigateTo')\r\n },\r\n methods: {\r\n addInterceptor() {\r\n uni.addInterceptor('navigateTo', interceptor)\r\n uni.showToast({\r\n title: '页面跳转已拦截'\r\n })\r\n this.msg = \"，路由被劫持到测试页面2\"\r\n },\r\n removeInterceptor() {\r\n uni.removeInterceptor('navigateTo', interceptor)\r\n uni.showToast({\r\n title: '拦截器已移除'\r\n })\r\n this.msg = \"会跳转到测试页面1\"\r\n },\r\n navigateTo() {\r\n uni.navigateTo({\r\n url: './page1',\r\n success(res) {\r\n console.log('res:', res)\r\n },\r\n fail(err) {\r\n console.error('err:', err)\r\n },\r\n complete(res) {\r\n console.log('res:', res)\r\n }\r\n })\r\n }\r\n }\r\n }\r\n\n```\n:::"},"getLaunchOptionsSync":{"name":"## uni.getLaunchOptionsSync() @getlaunchoptionssync","description":"\n获取本次启动时的参数。返回值与App.onLaunch的回调参数一致\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **OnLaunchOptions** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| path | string | 是 | - | - | - | \n","compatibility":"### getLaunchOptionsSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [getLaunchOptionsSync](https://doc.dcloud.net.cn/uni-app-x/api/get-launch-options-sync.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.get-launch-options-sync)\n"},"get-launch-options-sync":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-launch-options-sync/get-launch-options-sync.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-launch-options-sync/get-launch-options-sync\n>Template\n```vue\n\n\n\n\n```\n>Script\n```uts\n\nexport default {\n data() {\n return {\n checked: false,\n homePagePath: 'pages/tabBar/component',\n launchOptionsPath: '',\n }\n },\n methods: {\n getLaunchOptionsSync() {\n const launchOptions = uni.getLaunchOptionsSync()\n this.launchOptionsPath = launchOptions.path\n\n if (launchOptions.path == this.homePagePath) {\n this.checked = true\n }\n },\n },\n}\n\n```\n:::"},"exit":{"name":"## uni.exit(options?) @exit","description":"\n退出当前应用","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ExitOptions](#exitoptions-values) \\| null | 否 | - | - | uni.exit参数定义 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (res: [ExitSuccess](#exitsuccess-values)) => void \\| null | 否 | - | - | uni.exit成功回调函数定义 |\n@| fail | (res: [IExitError](#iexiterror-values)) => void \\| null | 否 | - | - | uni.exit失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.exit完成回调函数定义 | \n\n##### ExitSuccess 的属性值 @exitsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n\n##### IExitError 的属性值 @iexiterror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 12001 \\| 12002 | 是 | - | - | 错误码
- 12001: 系统不支持
- 12002: 未知错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### exit 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | x | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.exit)\n","example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/exit/exit.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n```"},"env":{"name":"## env","description":"","param":"### env 的属性值 @env-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| USER_DATA_PATH | string | 是 | - | | 应用专属存储空间的外置存储空间根目录下的files目录 |\n| CACHE_PATH | string | 是 | - | | 应用专属存储空间的外置存储空间根目录下的cache目录 |\n| SANDBOX_PATH | string | 是 | - | | 应用专属存储空间的外置存储空间根目录（caches/files） |\n","compatibility":"","returnValue":"","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.env)\n","example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/env/env.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"getPerformance":{"name":"## getPerformance","description":"\n返回一个Performance对象实例\n","param":"### getPerformance 的方法 @getperformance-values \n\n### createObserver(callback) @createobserver\n\n创建全局性能事件监听器\n#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (entries: [PerformanceObserverEntryList](#performanceobserverentrylist-values)) => void | 是 | - | - | - | \n\n##### PerformanceObserverEntryList 的方法 @performanceobserverentrylist-values \n\n##### getEntries() @getentries\n\n该方法返回当前列表中的所有性能数据\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<**PerformanceEntry**\\> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| entryType | string | 是 | - | - | 指标类型 |\n@| name | string | 是 | - | - | 指标名称 |\n@| duration | number | 是 | - | - | 耗时 ms。仅对于表示阶段的指标有效。 |\n@| startTime | number | 是 | - | - | 开始时间，不同指标的具体含义会有差异。 |\n@| path | string \\| null | 否 | - | - | 页面路径。仅 render 和 navigation 类型指标有效。 |\n@| referrerPath | string \\| null | 否 | - | - | 页面跳转来源页面路径。仅 route 指标有效。 |\n@| pageId | number \\| null | 否 | - | - | path 对应页面实例 Id（随机生成，不保证递增）。仅 render/navigation 指标有效。 |\n@| referrerPageId | number \\| null | 否 | - | - | referrerPath对应页面实例 Id（随机生成，不保证递增）。仅 route 指标有效。 |\n@| navigationStart | number \\| null | 否 | - | - | 路由真正响应开始时间。仅 navigation 类型指标有效。 |\n@| navigationType | string \\| null | 否 | - | - | 路由详细类型，与路由方法对应。仅 navigation 类型指标有效。 |\n@| initDataRecvTime | number \\| null | 否 | - | - | 首次渲染参数在渲染层收到的时间。仅 firstRender 指标有效。 |\n@| viewLayerRenderEndTime | number \\| null | 否 | - | - | 渲染层执行渲染结束时间。仅 firstRender 指标有效。 | \n\n###### getEntries 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### getEntriesByType(entryType) @getentriesbytype\n\n获取当前列表中所有类型为 \\[entryType]的性能数据\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| entryType | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[PerformanceEntry](#performanceentry-values)\\> |\n \n\n###### getEntriesByType 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### getEntriesByName(name, entryType) @getentriesbyname\n\n获取当前列表中所有名称为 \\[name] 且类型为 [entryType]的性能数据\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - |\n| entryType | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[PerformanceEntry](#performanceentry-values)\\> |\n \n\n###### getEntriesByName 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### 返回值 \n\n| 类型 |\n| :- |\n| [PerformanceObserver](#performanceobserver-values) |\n\n##### PerformanceObserver 的方法 @performanceobserver-values \n\n##### observe(options) @observe\n\n开始监听\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **PerformanceObserverOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| buffered | boolean | 否 | - | - | - |\n@| entryTypes | Array\\ | 否 | - | - | - |\n@| type | string | 否 | - | - | - | \n\n\n###### observe 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### disconnect() @disconnect\n\n停止监听\n\n\n###### disconnect 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n\n#### createObserver 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n### getEntries() @getentries\n\n该方法返回当前缓冲区中的所有性能数据\n\n#### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[PerformanceEntry](#performanceentry-values)\\> |\n \n\n#### getEntries 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n### getEntriesByType(entryType) @getentriesbytype\n\n获取当前缓冲区中所有类型为 \\[entryType]的性能数据\n#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| entryType | string | 是 | - | - | - | \n\n#### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[PerformanceEntry](#performanceentry-values)\\> |\n \n\n#### getEntriesByType 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n### getEntriesByName(name, entryType) @getentriesbyname\n\n获取当前缓冲区中所有名称为 \\[name] 且类型为 [entryType]的性能数据\n#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - |\n| entryType | string | 是 | - | - | - | \n\n#### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[PerformanceEntry](#performanceentry-values)\\> |\n \n\n#### getEntriesByName 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n### setBufferSize(size) @setbuffersize\n\n设置缓冲区大小，默认缓冲 30 条性能数据\n#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| size | number | 是 | - | - | - | \n\n\n#### setBufferSize 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n","compatibility":"","returnValue":"","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.get-performance)\n"},"navigateTo":{"name":"## uni.navigateTo(options) @navigateto","description":"\n保留当前页面，跳转到应用内的某个页面\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [NavigateToOptions](#navigatetooptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| url | string ([string.PageURIString](/uts/data-type.md#ide-string)) | 是 | - | | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n@| events | any \\| null | 否 | - | | 页面间通信接口，用于监听被打开页面发送到当前页面的数据 |\n@| success | (result: AsyncApiSuccessResult) => void \\| null | 否 | - | | 接口调用成功的回调函数 |\n@| fail | (result: [NavigateToFail](#navigatetofail-values)) => void \\| null | 否 | - | | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void \\| null | 否 | - | | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### NavigateToFail 的属性值 @navigatetofail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | 路由错误码 - 4: 框架内部异常 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### navigateTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/router?id=navigateto)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.navigateTo)\n"},"reLaunch":{"name":"## uni.reLaunch(options) @relaunch","description":"\n关闭所有页面，打开到应用内的某个页面\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ReLaunchOptions](#relaunchoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| url | string ([string.PageURIString](/uts/data-type.md#ide-string)) | 是 | - | | 需要跳转的应用内页面路径 , 路径后可以带参数。参数与路径之间使用?分隔，参数键与参数值用=相连，不同参数用&分隔；如 'path?key=value&key2=value2'，如果跳转的页面路径是 tabBar 页面则不能带参数 |\n@| success | (result: AsyncApiSuccessResult) => void \\| null | 否 | - | | 接口调用成功的回调函数 |\n@| fail | (result: [ReLaunchFail](#relaunchfail-values)) => void \\| null | 否 | - | | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void \\| null | 否 | - | | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### ReLaunchFail 的属性值 @relaunchfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### reLaunch 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/router?id=relaunch)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.reLaunch)\n"},"navigateBack":{"name":"## uni.navigateBack(options?) @navigateback","description":"\n关闭当前页面，返回上一页面或多级页面\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [NavigateBackOptions](#navigatebackoptions-values) \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| delta | number \\| null | 否 | - | | 返回的页面数，如果 delta 大于现有页面数，则返回到首页 |\n@| success | (result: AsyncApiSuccessResult) => void \\| null | 否 | - | | 接口调用成功的回调函数 |\n@| fail | (result: [NavigateBackFail](#navigatebackfail-values)) => void \\| null | 否 | - | | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void \\| null | 否 | - | | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### NavigateBackFail 的属性值 @navigatebackfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### navigateBack 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/router?id=navigateback)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.navigateBack)\n"},"redirectTo":{"name":"## uni.redirectTo(options) @redirectto","description":"\n关闭当前页面，跳转到应用内的某个页面\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [RedirectToOptions](#redirecttooptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| url | string ([string.PageURIString](/uts/data-type.md#ide-string)) | 是 | - | | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n@| success | (result: AsyncApiSuccessResult) => void \\| null | 否 | - | | 接口调用成功的回调函数 |\n@| fail | (result: [RedirectToFail](#redirecttofail-values)) => void \\| null | 否 | - | | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void \\| null | 否 | - | | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### RedirectToFail 的属性值 @redirecttofail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### redirectTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/router?id=redirectto)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.redirectTo)\n"},"switchTab":{"name":"## uni.switchTab(options) @switchtab","description":"\n跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SwitchTabOptions](#switchtaboptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| url | string ([string.PageURIString](/uts/data-type.md#ide-string)) | 是 | - | | 需要跳转的 tabBar 页面的路径，路径后不能带参数 |\n@| success | (result: AsyncApiSuccessResult) => void \\| null | 否 | - | | 接口调用成功的回调函数 |\n@| fail | (result: [SwitchTabFail](#switchtabfail-values)) => void \\| null | 否 | - | | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void \\| null | 否 | - | | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SwitchTabFail 的属性值 @switchtabfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### switchTab 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/router?id=switchtab)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.switchTab)\n"},"navigator":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/navigator/navigator.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/navigator/navigator\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { state, setLifeCycleNum } from '@/store/index.uts'\r\n\r\n export default {\r\n data() {\r\n return {\r\n onLoadTime: 0,\r\n onShowTime: 0,\r\n onReadyTime: 0,\r\n onHideTime: 0,\r\n }\r\n },\r\n onLoad() {\r\n this.onLoadTime = Date.now()\r\n console.log('onLoad', this.onLoadTime)\r\n },\r\n onShow() {\r\n this.onShowTime = Date.now()\r\n console.log('onShow', this.onShowTime)\r\n },\r\n onReady() {\r\n this.onReadyTime = Date.now()\r\n console.log('onReady', this.onReadyTime)\r\n },\r\n onHide() {\r\n this.onHideTime = Date.now()\r\n console.log('onHide', this.onHideTime)\r\n },\r\n onBackPress(options : OnBackPressOptions) : boolean | null {\r\n console.log('onBackPress', Date.now())\r\n console.log('onBackPress from', options.from)\r\n return null\r\n },\r\n onUnload() {\r\n console.log('onUnload', Date.now())\r\n },\r\n methods: {\r\n reLaunch() {\r\n uni.reLaunch({\r\n url: '/pages/tabBar/component',\r\n success(result) {\r\n console.log('reLaunch success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('reLaunch fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('reLaunch complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateTo() {\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1?data=Hello',\r\n success(result) {\r\n console.log('navigateTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateTo fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateToErrorPage() {\r\n uni.navigateTo({\r\n url: '/pages/error-page/error-page',\r\n success(result) {\r\n console.log('navigateTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n fail(error) {\r\n console.log('navigateTo fail', error.errMsg)\r\n uni.showToast({\r\n title: error.errMsg,\r\n icon: 'none',\r\n })\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n complete(result) {\r\n console.log('navigateTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateToDebounce() {\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1?data=debounce',\r\n success(result) {\r\n console.log('navigateTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateTo fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1?data=debounce',\r\n success(result) {\r\n console.log('navigateTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n fail(error) {\r\n console.log('navigateTo fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n complete(result) {\r\n console.log('navigateTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n // 自动化测试\r\n navigateToRelativePath1() {\r\n uni.navigateTo({\r\n url: 'new-page/new-page-1?data=new-page/new-page-1',\r\n success() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail() {\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n // 自动化测试\r\n navigateToRelativePath2() {\r\n uni.navigateTo({\r\n url: './new-page/new-page-1?data=./new-page/new-page-1',\r\n success() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail() {\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n // 自动化测试\r\n navigateToRelativePath3() {\r\n uni.navigateTo({\r\n url: '../navigator/new-page/new-page-1?data=../navigator/new-page/new-page-1',\r\n success() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail() {\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateBack() {\r\n uni.navigateBack({\r\n success(result) {\r\n console.log('navigateBack success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateBack fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateBack complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateBackWithDelta1() {\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1',\r\n success() {\r\n uni.navigateBack({\r\n delta: 1,\r\n success(result) {\r\n console.log('navigateBack success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateBack fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateBack complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n })\r\n },\r\n navigateBackWithDelta100() {\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1',\r\n success() {\r\n uni.navigateBack({\r\n delta: 100,\r\n success(result) {\r\n console.log('navigateBack success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateBack fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateBack complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n })\r\n },\r\n redirectTo() {\r\n uni.redirectTo({\r\n url: '/pages/API/navigator/new-page/new-page-1?data=Hello',\r\n success(result) {\r\n console.log('redirectTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('redirectTo fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('redirectTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n switchTab() {\r\n uni.switchTab({\r\n url: '/pages/tabBar/template',\r\n success(result) {\r\n console.log('switchTab success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('switchTab fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('switchTab complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n // 自动化测试\r\n getLifeCycleNum() : number {\r\n return state.lifeCycleNum\r\n },\r\n // 自动化测试\r\n setLifeCycleNum(num : number) {\r\n setLifeCycleNum(num)\r\n },\r\n },\r\n }\r\n\n```\n:::"},"setNavigationBarColor":{"name":"## uni.setNavigationBarColor(options) @setnavigationbarcolor","description":"\n设置导航条、状态栏颜色\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SetNavigationBarColorOptions](#setnavigationbarcoloroptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| frontColor | \"#ffffff\" \\| \"#000000\" | 是 | - | | 前景颜色值，包括按钮、标题、状态栏的颜色，仅支持 #ffffff 和 #000000 |\n@| backgroundColor | [string.ColorString](/uts/data-type.md#ide-string) | 是 | - | | 背景颜色值，有效值为十六进制颜色 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | | 接口调用成功的回调函数 |\n@| fail | (error: [SetNavigationBarColorFail](#setnavigationbarcolorfail-values)) => void | 否 | - | | 接口调用失败的回调函数 |\n@| complete | (res: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetNavigationBarColorFail 的属性值 @setnavigationbarcolorfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### setNavigationBarColor 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [setNavigationBarColor](https://doc.dcloud.net.cn/uni-app-x/api/set-navigation-bar-color.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-navigation-bar-color)\n"},"set-navigation-bar-color":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/set-navigation-bar-color/set-navigation-bar-color.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/set-navigation-bar-color/set-navigation-bar-color\n>Template\n```vue\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { state, setLifeCycleNum } from '@/store/index.uts'\r\n\r\n export default {\r\n methods: {\r\n setNavigationBarColor1() {\r\n uni.setNavigationBarColor({\r\n frontColor: '#ffffff',\r\n backgroundColor: '#00ff00',\r\n success: () => {\r\n console.log('setNavigationBarColor success')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail: () => {\r\n console.log('setNavigationBarColor fail')\r\n this.setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete: () => {\r\n console.log('setNavigationBarColor complete')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n }\r\n })\r\n },\r\n setNavigationBarColor2() {\r\n uni.setNavigationBarColor({\r\n frontColor: '#000000',\r\n backgroundColor: '#ff0000',\r\n success: () => {\r\n console.log('setNavigationBarColor success')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail: () => {\r\n console.log('setNavigationBarColor fail')\r\n this.setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete: () => {\r\n console.log('setNavigationBarColor complete')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n }\r\n })\r\n },\r\n // 自动化测试\r\n getLifeCycleNum() : number {\r\n return state.lifeCycleNum\r\n },\r\n // 自动化测试\r\n setLifeCycleNum(num : number) {\r\n setLifeCycleNum(num)\r\n },\r\n goNavbarLite() {\r\n uni.navigateTo({\r\n url: '/pages/template/navbar-lite/navbar-lite'\r\n })\r\n }\r\n },\r\n }\r\n\n```\n:::"},"setNavigationBarTitle":{"name":"## uni.setNavigationBarTitle(options) @setnavigationbartitle","description":"\n动态设置当前页面的标题\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SetNavigationBarTitleOptions](#setnavigationbartitleoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| title | string | 是 | - | | 页面标题 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | | 接口调用成功的回调函数 |\n@| fail | (error: [SetNavigationBarTitleFail](#setnavigationbartitlefail-values)) => void | 否 | - | | 接口调用失败的回调函数 |\n@| complete | (res: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetNavigationBarTitleFail 的属性值 @setnavigationbartitlefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### setNavigationBarTitle 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.97 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [setNavigationBarTitle](https://doc.dcloud.net.cn/uni-app-x/api/set-navigation-bar-title.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-navigation-bar-title)\n"},"set-navigation-bar-title":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/set-navigation-bar-title/set-navigation-bar-title.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/set-navigation-bar-title/set-navigation-bar-title\n>Template\n```vue\n\n\n\n\n```\n>Script\n```uts\n\n import { state, setLifeCycleNum } from '@/store/index.uts'\n\n export default {\n data() {\n return {\n newTitle: 'new title',\n longTitle: 'long title long title long title long title long title long title long title long title long title long title'\n }\n },\n methods: {\n setNavigationBarNewTitle() {\n uni.setNavigationBarTitle({\n title: this.newTitle,\n success: () => {\n console.log('setNavigationBarTitle success')\n this.setLifeCycleNum(state.lifeCycleNum + 1)\n },\n fail: () => {\n console.log('setNavigationBarTitle fail')\n this.setLifeCycleNum(state.lifeCycleNum - 1)\n },\n complete: () => {\n console.log('setNavigationBarTitle complete')\n this.setLifeCycleNum(state.lifeCycleNum + 1)\n }\n })\n },\n setNavigationBarLongTitle() {\n uni.setNavigationBarTitle({\n title: this.longTitle,\n success() {\n console.log('setNavigationBarTitle success')\n },\n fail() {\n console.log('setNavigationBarTitle fail')\n },\n complete() {\n console.log('setNavigationBarTitle complete')\n }\n })\n },\n // 自动化测试\n getLifeCycleNum() : number {\n return state.lifeCycleNum\n },\n // 自动化测试\n setLifeCycleNum(num : number) {\n setLifeCycleNum(num)\n }\n },\n }\n\n```\n:::"},"showTabBar":{"name":"## uni.showTabBar(options?) @showtabbar","description":"\n显示 tabBar\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ShowTabBarOptions](#showtabbaroptions-values) \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| animation | boolean | 否 | - | - | 是否需要动画效果 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [SetTabBarFail](#settabbarfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 100 \\| 200 | 是 | - | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### showTabBar 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [showTabBar](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#showtabbar)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.showTabBar)\n"},"hideTabBar":{"name":"## uni.hideTabBar(options?) @hidetabbar","description":"\n隐藏 tabBar\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [HideTabBarOptions](#hidetabbaroptions-values) \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| animation | boolean | 否 | - | - | 是否需要动画效果 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [SetTabBarFail](#settabbarfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 100 \\| 200 | 是 | - | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### hideTabBar 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [hideTabBar](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#hidetabbar)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.hideTabBar)\n"},"showTabBarRedDot":{"name":"## uni.showTabBarRedDot(options) @showtabbarreddot","description":"\n显示 tabBar 某一项的右上角的红点\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ShowTabBarRedDotOptions](#showtabbarreddotoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| index | number | 是 | - | - | tabBar的哪一项，从左边算起，索引从0开始 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [SetTabBarFail](#settabbarfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 100 \\| 200 | 是 | - | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### showTabBarRedDot 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [showTabBarRedDot](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#showtabbarreddot)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.showTabBarRedDot)\n"},"hideTabBarRedDot":{"name":"## uni.hideTabBarRedDot(options) @hidetabbarreddot","description":"\n隐藏 tabBar 某一项的右上角的红点\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [HideTabBarRedDotOptions](#hidetabbarreddotoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| index | number | 是 | - | - | tabBar的哪一项，从左边算起，索引从0开始 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [SetTabBarFail](#settabbarfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 100 \\| 200 | 是 | - | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### hideTabBarRedDot 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [hideTabBarRedDot](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#hidetabbarreddot)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.hideTabBarRedDot)\n"},"setTabBarBadge":{"name":"## uni.setTabBarBadge(options) @settabbarbadge","description":"\n为 tabBar 某一项的右上角添加文本\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SetTabBarBadgeOptions](#settabbarbadgeoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| index | number | 是 | - | - | tabBar的哪一项，从左边算起，索引从0开始 |\n@| text | string | 是 | - | - | 显示的文本，不超过 3 个半角字符 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [SetTabBarFail](#settabbarfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 100 \\| 200 | 是 | - | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### setTabBarBadge 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [setTabBarBadge](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#settabbarbadge)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.setTabBarBadge)\n"},"removeTabBarBadge":{"name":"## uni.removeTabBarBadge(options) @removetabbarbadge","description":"\n移除 tabBar 某一项右上角的文本\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [RemoveTabBarBadgeOptions](#removetabbarbadgeoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| index | number | 是 | - | - | tabBar的哪一项，从左边算起，索引从0开始 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [SetTabBarFail](#settabbarfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 100 \\| 200 | 是 | - | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### removeTabBarBadge 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [removeTabBarBadge](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#removetabbarbadge)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.removeTabBarBadge)\n"},"setTabBarStyle":{"name":"## uni.setTabBarStyle(options) @settabbarstyle","description":"\n动态设置 tabBar 的整体样式\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SetTabBarStyleOptions](#settabbarstyleoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| color | string ([string.ColorString](/uts/data-type.md#ide-string)) | 否 | - | - | tab 上的文字默认颜色 |\n@| selectedColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | 否 | - | - | tab 上的文字选中时的颜色 |\n@| backgroundColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | 否 | - | - | tab 的背景色 |\n@| backgroundImage | string | 否 | - | - | 图片背景 |\n@| backgroundRepeat | \"repeat\" \\| \"repeat-x\" \\| \"repeat-y\" \\| \"no-repeat\" | 否 | - | - | 背景图平铺方式
- repeat: 背景图片在垂直方向和水平方向平铺
- repeat-x: 背景图片在水平方向平铺，垂直方向拉伸
- repeat-y: 背景图片在垂直方向平铺，水平方向拉伸
- no-repeat: 背景图片在垂直方向和水平方向都拉伸 |\n@| borderStyle | string | 否 | - | - | tabbar上边框的颜色 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [SetTabBarFail](#settabbarfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 100 \\| 200 | 是 | - | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### setTabBarStyle 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [setTabBarStyle](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#settabbarstyle)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.setTabBarStyle)\n"},"setTabBarItem":{"name":"## uni.setTabBarItem(options) @settabbaritem","description":"\n动态设置 tabBar 某一项的内容\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SetTabBarItemOptions](#settabbaritemoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| index | number | 是 | - | - | tabBar 的哪一项，从左边算起，索引从0开始 |\n@| text | string | 否 | - | - | tab 上按钮文字 |\n@| iconPath | string | 否 | - | - | 图片路径 |\n@| selectedIconPath | string | 否 | - | - | 选中时的图片路径 |\n@| pagePath | string | 否 | - | - | 页面绝对路径 |\n@| iconfont | **SetTabBarItemIconFontOptions** | 否 | - | - | 字体图标，优先级高于 iconPath |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| text | string | 是 | - | - | 字库 Unicode 码 |\n@@| selectedText | string | 是 | - | - | 选中后字库 Unicode 码 |\n@@| fontSize | string | 否 | - | - | 字体图标字号(px) |\n@@| color | string | 否 | - | - | 字体图标颜色 |\n@@| selectedColor | string | 否 | - | - | 字体图标选中颜色 |\n@| visible | boolean | 否 | - | - | tab 是否显示 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [SetTabBarFail](#settabbarfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 100 \\| 200 | 是 | - | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### setTabBarItem 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [setTabBarItem](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#settabbaritem)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.setTabBarItem)\n"},"startPullDownRefresh":{"name":"## uni.startPullDownRefresh(options?) @startpulldownrefresh","description":"\n开始下拉刷新\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [StartPullDownRefreshOptions](#startpulldownrefreshoptions-values) \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [StartPullDownRefreshFail](#startpulldownrefreshfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### StartPullDownRefreshFail 的属性值 @startpulldownrefreshfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### startPullDownRefresh 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.io/uni-app-x/api/pull-down-refresh.html#startpulldownrefresh)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.pull-down-refresh.startPullDownRefresh)\n"},"stopPullDownRefresh":{"name":"## uni.stopPullDownRefresh() @stoppulldownrefresh","description":"\n停止当前页面下拉刷新\n","param":"","returnValue":"","compatibility":"### stopPullDownRefresh 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [stopPullDownRefresh](https://doc.dcloud.net.cn/uni-app-x/api/pull-down-refresh.html#stoppulldownrefresh)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.pull-down-refresh.stopPullDownRefresh)\n"},"pull-down-refresh":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/pull-down-refresh/pull-down-refresh.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/pull-down-refresh/pull-down-refresh\n>Template\n```vue\n\n\n\n\n\n```\n>Script\n```uts\n\n\texport default {\n\t\tdata() {\n\t\t\treturn {\n\t\t\t\tdata: [] as Array,\n\t\t\t\tloadMoreText: \"加载中...\",\n\t\t\t\tshowLoadMore: false,\n\t\t\t\tmax: 0\n\t\t\t}\n\t\t},\n\t\tonReady() {\n uni.startPullDownRefresh();\n\t\t\tthis.initData();\n\t\t},\n\t\tonReachBottom() {\n\t\t\tconsole.log(\"onReachBottom\");\n\t\t\tif (this.max > 40) {\n\t\t\t\tthis.loadMoreText = \"没有更多数据了!\"\n\t\t\t\treturn;\n\t\t\t}\n\t\t\tthis.showLoadMore = true;\n\t\t\tsetTimeout(() => {\n\t\t\t\tthis.setListData();\n\t\t\t}, 300);\n\t\t},\n\t\tonPullDownRefresh() {\n\t\t\tconsole.log('onPullDownRefresh');\n\t\t\tthis.initData();\n\t\t},\n\t\tmethods: {\n\t\t\tinitData(){\n\t\t\t\tsetTimeout(() => {\n\t\t\t\t\tthis.max = 0;\n\t\t\t\t\tthis.data = [];\n\t\t\t\t\tlet data:Array = [];\n\t\t\t\t\tthis.max += 20;\n\t\t\t\t\tfor (let i:number = this.max - 19; i < this.max + 1; i++) {\n\t\t\t\t\t\tdata.push(i)\n\t\t\t\t\t}\n\t\t\t\t\tthis.data = this.data.concat(data);\n\t\t\t\t\tuni.stopPullDownRefresh();\n\t\t\t\t}, 1000);\n\t\t\t},\n\t\t\tsetListData() {\n\t\t\t\tlet data:Array = [];\n\t\t\t\tthis.max += 10;\n\t\t\t\tfor (let i:number = this.max - 9; i < this.max + 1; i++) {\n\t\t\t\t\tdata.push(i)\n\t\t\t\t}\n\t\t\t\tthis.data = this.data.concat(data);\n\t\t\t}\n\t\t}\n\t}\n\n```\n:::"},"pageScrollTo":{"name":"## uni.pageScrollTo(options) @pagescrollto","description":"\n将页面滚动到目标位置\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [PageScrollToOptions](#pagescrolltooptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| scrollTop | number \\| null | 否 | - | - | 滚动到页面的目标位置 |\n@| selector | string \\| null | 否 | - | - | 选择器 |\n@| offsetTop | number \\| null | 否 | - | | 偏移距离，可以滚动到 selector 加偏移距离的位置 |\n@| duration | number \\| null | 否 | - | - | 滚动动画的时长 |\n@| success | (result: AsyncApiSuccessResult) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [PageScrollToFail](#pagescrolltofail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### PageScrollToFail 的属性值 @pagescrolltofail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### pageScrollTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [pageScrollTo](https://doc.dcloud.net.cn/uni-app-x/api/page-scroll-to.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.page-scroll-to)\n"},"page-scroll-to":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/page-scroll-to/page-scroll-to.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/page-scroll-to/page-scroll-to\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: 'pageScrollTo',\n }\n },\n methods: {\n scrollTo() {\n uni.pageScrollTo({\n scrollTop: 100,\n duration: 300,\n success: () => {\n console.log('success')\n },\n })\n },\n scrollToElement() {\n uni.pageScrollTo({\n selector: '.custom-element',\n duration: 300,\n success: () => {\n console.log('success')\n },\n })\n },\n },\n }\n\n```\n:::"},"getElementById":{"name":"## uni.getElementById(id) @getelementbyid","description":"\n返回一个匹配特定 ID 的元素， 如果不存在，返回 null。\\\n如果需要获取指定的节点类型，需要使用 as 进行类型转换。\\\nID 区分大小写，且应该是唯一的。如果存在多个匹配的元素，则返回第一个匹配的元素。\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| id | [string.IDString](/uts/data-type.md#ide-string) \\| string | 是 | - | - | - | \n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UniElement](/dom/unielement.md) \\| null | 否 |\n \n","compatibility":"### getElementById 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [getElementById](https://doc.dcloud.net.cn/uni-app-x/api/get-element.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.dom.get-element.getElementById)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-element-by-id/get-element-by-id.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-element-by-id/get-element-by-id\n>Template\n```vue\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n checked: false,\r\n homePagePath: '/pages/tabBar/component',\r\n launchOptionsPath: '',\r\n }\r\n },\n methods: {\r\n getElementByNotExistId() : Element | null {\r\n return uni.getElementById('not-exist-id')\r\n },\r\n changePageHeadBackgroundColor() {\r\n const pageHead = uni.getElementById('page-head')!\r\n pageHead.style.setProperty('background-color', 'red')\r\n },\r\n changeTextColor() {\r\n const text = uni.getElementById('text')!\r\n text.style.setProperty('color', 'red')\r\n },\r\n changeViewStyle() {\r\n const view = uni.getElementById('view')\r\n if (view !== null) {\r\n view.style.setProperty('width', '90%')\r\n view.style.setProperty('height', '50px')\r\n view.style.setProperty('background-color', '#007AFF')\r\n }\r\n },\r\n goMultipleRootNode() {\r\n uni.navigateTo({ url: '/pages/API/get-element-by-id/get-element-by-id-multiple-root-node' })\r\n },\n //自动化测试获取text元素的offsetLeft属性值\n getTextOffsetLeft(): number {\n const text = uni.getElementById('text')!\n return text.offsetLeft\n }\r\n }\r\n }\r\n\n```\n:::"},"createSelectorQuery":{"name":"## uni.createSelectorQuery() @createselectorquery","description":"\n返回一个SelectorQuery对象实例\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n\n#### SelectorQuery 的方法 @selectorquery-values \n\n#### in(component?) @in\n\n将选择器的选取范围更改为自定义组件component内\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| component | any \\| null | 否 | - | - | | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n##### in 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### select(selector) @select\n\n在当前页面下选择第一个匹配选择器selector的节点\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| selector | string | 是 | - | - | - | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [NodesRef](#nodesref-values) |\n\n##### NodesRef 的方法 @nodesref-values \n\n##### boundingClientRect(callback?) @boundingclientrect\n\n添加节点的布局位置的查询请求，相对于显示区域，以像素为单位\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: any) => void \\| null | 否 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n###### boundingClientRect 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### scrollOffset(callback) @scrolloffset\n\n添加节点的滚动位置查询请求，以像素为单位\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: any) => void | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n###### scrollOffset 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### fields(fields, callback) @fields\n\n获取节点的相关信息，需要获取的字段在fields中指定\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| fields | **NodeField** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| id | boolean \\| null | 否 | - | - | 是否返回节点 id |\n@| dataset | boolean \\| null | 否 | - | - | 是否返回节点 dataset |\n@| rect | boolean \\| null | 否 | - | - | 是否返回节点布局位置（left right top bottom） |\n@| size | boolean \\| null | 否 | - | - | 是否返回节点尺寸（width height） |\n@| scrollOffset | boolean \\| null | 否 | - | - | 是否返回节点的 scrollLeft scrollTop，节点必须是 scroll-view 或者 viewport |\n@| properties | Array\\ \\| null | 否 | - | - | 指定属性名列表，返回节点对应属性名的当前属性值（只能获得组件文档中标注的常规属性值，id class style 和事件绑定的属性值不可获取） |\n@| computedStyle | Array\\ \\| null | 否 | - | - | 指定样式名列表，返回节点对应样式名的当前值 |\n@| context | boolean \\| null | 否 | - | | 是否返回节点对应的 Context 对象 |\n| callback | (result: any) => void | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n###### fields 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### context(callback) @context\n\n添加节点的 Context 对象查询请求\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: any) => void | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n###### context 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |\n\n\n##### node(callback) @node\n\n获取 Node 节点实例。目前支持 Canvas 的获取。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: any) => void | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n###### node 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n\n##### select 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### selectAll(selector) @selectall\n\n在当前页面下选择匹配选择器selector的所有节点\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| selector | string | 是 | - | - | - | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [NodesRef](#nodesref-values) |\n \n\n##### selectAll 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### selectViewport() @selectviewport\n\n选择显示区域\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [NodesRef](#nodesref-values) |\n \n\n##### selectViewport 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### exec(callback) @exec\n\n执行所有的请求\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: Array\\) => void \\| null | 是 | - | - | - | \n\n##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [NodesRef](#nodesref-values) \\| null | 否 |\n \n\n##### exec 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n","compatibility":"### createSelectorQuery 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [createSelectorQuery](https://doc.dcloud.net.cn/uni-app-x/api/nodes-info.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.dom.nodes-info.createSelectorQuery)\n"},"nodes-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/nodes-info/nodes-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/nodes-info/nodes-info\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import nodeChild from './nodes-info-child.uvue'\r\n\r\n type NodeInfoType = {\r\n left : number | null,\r\n top : number | null,\r\n right : number | null,\r\n bottom : number | null,\r\n width : number | null,\r\n height : number | null,\r\n }\r\n\r\n export default {\r\n components: {\r\n nodeChild\r\n },\r\n data() {\r\n return {\r\n title: 'createSelectorQuery',\r\n nodeInfoList: [] as NodeInfoType[],\r\n // 仅用于自动化测试\r\n rootNodeInfo: null as NodeInfoType | null,\r\n //供自动化测试使用\r\n // resizeRectValid: false\r\n }\r\n },\r\n onResize() {\r\n //供自动化测试使用\r\n /* var rect12Element = uni.getElementById(\"rect-1-2\")\r\n if(rect12Element != null) {\r\n var domRect = rect12Element.getBoundingClientRect()\r\n if(domRect.width > 100) {\r\n this.resizeRectValid = true\r\n }\r\n } */\r\n },\r\n methods: {\r\n // 仅用于自动化测试\r\n getRootNodeInfo(selector : string) {\r\n uni.createSelectorQuery().select(selector).boundingClientRect().exec((ret) => {\r\n if (ret.length == 1) {\r\n const nodeInfo = ret[0] as NodeInfo;\r\n const nodeType = {\r\n left: nodeInfo.left,\r\n top: nodeInfo.top,\r\n right: nodeInfo.right,\r\n bottom: nodeInfo.bottom,\r\n width: nodeInfo.width,\r\n height: nodeInfo.height,\r\n } as NodeInfoType;\r\n this.rootNodeInfo = nodeType\r\n }\r\n })\r\n },\r\n getNodeInfo() {\r\n uni.createSelectorQuery().select('.rect1').boundingClientRect().exec((ret) => {\r\n this.nodeInfoList.length = 0\r\n const i = ret[0] as NodeInfo\r\n this.nodeInfoList.push({\r\n left: i.left,\r\n top: i.top,\r\n right: i.right,\r\n bottom: i.bottom,\r\n width: i.width,\r\n height: i.height,\r\n } as NodeInfoType)\r\n })\r\n },\r\n getAllNodeInfo() {\r\n uni.createSelectorQuery().selectAll('.rect').boundingClientRect().exec((ret) => {\r\n this.nodeInfoList.length = 0\r\n const array = ret[0] as NodeInfo[]\r\n array.forEach((i) => {\r\n this.nodeInfoList.push({\r\n left: i.left,\r\n top: i.top,\r\n right: i.right,\r\n bottom: i.bottom,\r\n width: i.width,\r\n height: i.height,\r\n } as NodeInfoType)\r\n })\r\n })\r\n }\r\n }\r\n }\r\n\n```\n:::"},"showActionSheet":{"name":"## uni.showActionSheet(options) @showactionsheet","description":"从底部向上弹出操作菜单","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ShowActionSheetOptions](#showactionsheetoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| title | string \\| null | 否 | - | - | 菜单标题 |\n@| alertText | string \\| null | 否 | - | - | 警示文案（同菜单标题, app无效） |\n@| itemList | Array\\ | 是 | - | - | 按钮的文字数组 |\n@| itemColor | [string.ColorString](/uts/data-type.md#ide-string) \\| null | 否 | - | - | 按钮的文字颜色，字符串格式（iOS默认为系统控件颜色） |\n@| popover | **Popover** \\| null | 否 | - | - | 大屏设备弹出原生选择按钮框的指示区域，默认居中显示 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| top | number | 是 | - | - | 指示区域坐标，使用原生 navigationBar 时一般需要加上 navigationBar 的高度 |\n@@| left | number | 是 | - | - | 指示区域坐标 |\n@@| width | number | 是 | - | - | 指示区域宽度 |\n@@| height | number | 是 | - | - | 指示区域高度 |\n@| success | (res: [ShowActionSheetSuccess](#showactionsheetsuccess-values)) => void \\| null | 否 | - | - | uni.showActionSheet成功回调函数定义 |\n@| fail | (res: [IPromptError](#iprompterror-values)) => void \\| null | 否 | - | - | uni.showActionSheet成功回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.showActionSheet成功回调函数定义 | \n\n##### ShowActionSheetSuccess 的属性值 @showactionsheetsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tapIndex | number \\| null | 否 | - | - | 用户点击的按钮，从上到下的顺序，从0开始 |\n\n##### IPromptError 的属性值 @iprompterror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1 \\| 1001 | 是 | - | - | 错误码
- 1\t 撤销
- 1001 请求参数非法 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### showActionSheet 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showactionsheet)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.prompt.showActionSheet)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/action-sheet/action-sheet.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/action-sheet/action-sheet\n>Template\n```vue\n\r\n\n\n```\n>Script\n```uts\n\r\n type ItemType = {\r\n value : string,\r\n name : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'action-sheet',\r\n itemColorCustom: false,\r\n itemContentLarge: false,\r\n itemNumLargeSelect: false,\n showErrorToast:true,\r\n items: [{\r\n value: '标题',\r\n name: '有标题'\r\n },\r\n {\r\n value: '',\r\n name: '无标题'\r\n },\r\n {\r\n value: '超长标题测试内容，测试超过显示最大范围之后的样式-超长标题测试内容，测试超过显示最大范围之后的样式',\r\n name: '超长标题'\r\n }\r\n ] as ItemType[],\r\n current: 0,\r\n }\r\n },\n onLoad(){\n uni.showActionSheet({\n title: \"onLoad 调用示例,请手动取消\",\n itemList:['item1', 'item2'],\n })\n },\r\n methods: {\n //自动化测试例专用\n jest_getWindowInfo() : GetWindowInfoResult {\n return uni.getWindowInfo();\n },\r\n radioChange(e : UniRadioGroupChangeEvent) {\r\n for (let i = 0; i < this.items.length; i++) {\r\n if (this.items[i].value === e.detail.value) {\r\n this.current = i;\r\n break;\r\n }\r\n }\r\n },\r\n itemContentLargeChange: function (e : UniSwitchChangeEvent) {\r\n this.itemContentLarge = e.detail.value\r\n },\r\n itemColorChange: function (e : UniSwitchChangeEvent) {\r\n this.itemColorCustom = e.detail.value\r\n },\r\n itemNumLargeChange: function (e : UniSwitchChangeEvent) {\r\n this.itemNumLargeSelect = e.detail.value\r\n },\r\n actionSheetTap() {\r\n\r\n let itemInfo = ['item1', 'item2', 'item3', 'item4']\r\n\r\n if (this.itemContentLarge) {\r\n itemInfo = ['两个黄鹂鸣翠柳，一行白鹭上青天。窗含西岭千秋雪，门泊东吴万里船', '水光潋滟晴方好,山色空蒙雨亦奇。 欲把西湖比西子,淡妆浓抹总相宜', '']\r\n }\n\n if (this.itemNumLargeSelect) {\r\n // 大量选项测试,不能超过6个元素 https://uniapp.dcloud.net.cn/api/ui/prompt.html#showactionsheet\r\n itemInfo = []\n for (var i = 1; i <= 10; i++) {\r\n itemInfo.push('两个黄鹂鸣翠柳，一行白鹭上青天');\r\n }\r\n }\r\n\r\n const that = this\r\n if (this.itemColorCustom) {\r\n uni.showActionSheet({\r\n title: this.items[this.current].value,\r\n itemList: itemInfo,\r\n itemColor: \"#ff00ff\",\r\n success: (e) => {\r\n console.log(e.tapIndex);\r\n uni.showToast({\r\n title: \"点击了第\" + e.tapIndex + \"个选项\",\r\n icon: \"none\"\r\n })\r\n },\r\n fail: (e) => {\n if(this.showErrorToast){\n uni.showToast({\n title: e.errMsg,\n icon: \"none\"\n })\n }\r\n console.log(e);\r\n }\r\n })\r\n } else {\r\n uni.showActionSheet({\r\n title: this.items[this.current].value,\r\n itemList: itemInfo,\r\n success: (e) => {\r\n console.log(e.tapIndex);\r\n uni.showToast({\r\n title: \"点击了第\" + e.tapIndex + \"个选项\",\r\n icon: \"none\"\r\n })\r\n },\r\n fail: (e) => {\r\n console.log(e);\n if(this.showErrorToast){\n uni.showToast({\n title: e.errMsg,\n icon: \"none\"\n })\n }\n }\r\n })\r\n }\r\n },\r\n }\r\n }\r\n\n```\n:::"},"showLoading":{"name":"## uni.showLoading(options) @showloading","description":"显示 loading 提示框, 需主动调用 uni.hideLoading 才能关闭提示框。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ShowLoadingOptions](#showloadingoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| title | string | 是 | - | - | 提示的内容，长度与 icon 取值有关。 |\n@| mask | boolean \\| null | 否 | - | - | 是否显示透明蒙层，防止触摸穿透，默认：false |\n@| success | (res: ShowLoadingSuccess) => void \\| null | 否 | - | - | uni.showLoading成功回调函数定义 |\n@| fail | (res: [IPromptError](#iprompterror-values)) => void \\| null | 否 | - | - | uni.showLoading失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.showLoading完成回调函数定义 | \n\n##### IPromptError 的属性值 @iprompterror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1 \\| 1001 | 是 | - | - | 错误码
- 1\t 撤销
- 1001 请求参数非法 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### showLoading 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showloading)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.prompt.showLoading)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/loading/loading.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/loading/loading\n>Template\n```vue\n\n\n\n```\n>Script\n```uts\n\n type ItemType = {\n value : string\n name : string\n }\n export default {\n data() {\n return {\n title: 'loading',\n items: [\n {\n value: 'null',\n name: '无标题',\n },\n {\n value: '三秒后自动关闭',\n name: '普通标题',\n },\n {\n value: '超长文本内容，测试超出范围-超长文本内容，测试超出范围-三秒后自动关闭',\n name: '长标题',\n },\n ] as ItemType[],\n current: 0,\n maskSelect: false,\n titleSelect: \"null\"\n }\n },\n onLoad(){\n uni.showLoading({\n \ttitle:'onLoad 调用示例,2秒后消失'\n })\n setTimeout(function() {\n uni.hideLoading()\n }, 2000);\n },\n methods: {\n //自动化测试例专用\n jest_getWindowInfo() : GetWindowInfoResult {\n return uni.getWindowInfo();\n },\n\n radioChange(e : UniRadioGroupChangeEvent) {\n const selected = this.items.find((item) : boolean => {\n return item.value == e.detail.value\n })\n if (selected != null) {\n this.titleSelect = selected.value\n }\n },\n maskChange: function (e : UniSwitchChangeEvent) {\n this.maskSelect = e.detail.value\n },\n showLoading: function () {\n\n console.log(this.titleSelect)\n if (this.titleSelect == \"null\") {\n uni.showLoading({\n title: \"\",\n mask: this.maskSelect\n });\n } else {\n uni.showLoading({\n title: this.titleSelect,\n mask: this.maskSelect\n });\n }\n setTimeout(() => {\n this.hideLoading();\n }, 3000);\n },\n hideLoading: function () {\n uni.hideLoading();\n }\n }\n }\n\n```\n:::"},"showModal":{"name":"## uni.showModal(options) @showmodal","description":"显示模态弹窗，可以只有一个确定按钮，也可以同时有确定和取消按钮。类似于一个API整合了 html 中：alert、confirm。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ShowModalOptions](#showmodaloptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| title | string \\| null | 否 | - | - | 提示的标题 |\n@| content | string \\| null | 否 | - | - | 提示的内容 |\n@| showCancel | boolean \\| null | 否 | true
是否显示取消按钮，默认为 true | - | |\n@| cancelText | string \\| null | 否 | - | - | 取消按钮的文字，默认为\"取消\" |\n@| cancelColor | [string.ColorString](/uts/data-type.md#ide-string) \\| null | 否 | - | - | 取消按钮的文字颜色，默认为\"#000000\" |\n@| confirmText | string \\| null | 否 | - | - | 确定按钮的文字，默认为\"确定\" |\n@| confirmColor | [string.ColorString](/uts/data-type.md#ide-string) \\| null | 否 | - | - | 确定按钮的文字颜色 |\n@| editable | boolean \\| null | 否 | false
是否显示输入框 | - | |\n@| placeholderText | string \\| null | 否 | - | - | 显示输入框时的提示文本 |\n@| success | (res: [ShowModalSuccess](#showmodalsuccess-values)) => void \\| null | 否 | - | - | uni.showModal成功回调函数定义 |\n@| fail | (res: [IPromptError](#iprompterror-values)) => void \\| null | 否 | - | - | uni.showModal失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.showModal完成回调函数定义 | \n\n##### ShowModalSuccess 的属性值 @showmodalsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| confirm | boolean | 是 | - | - | 为 true 时，表示用户点击了确定按钮 |\n| cancel | boolean | 是 | - | - | 为 true 时，表示用户点击了取消（用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭） |\n| content | string \\| null | 否 | - | - | editable 为 true 时，用户输入的文本 |\n\n##### IPromptError 的属性值 @iprompterror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1 \\| 1001 | 是 | - | - | 错误码
- 1\t 撤销
- 1001 请求参数非法 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### showModal 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showmodal)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.prompt.showModal)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/modal/modal.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/modal/modal\n>Template\n```vue\n\n\n\n\n```\n>Script\n```uts\n\n type ItemType = {\n value : string,\n name : string,\n }\n export default {\n data() {\n return {\n title: 'modal',\n showCancelSelect: false,\n cancelTextSelect: false,\n confirmTextSelect: false,\n editableSelect: false,\n placeholderTextSelect: false,\n exeRet: \"\",\n items: [{\n value: '标题',\n name: '有标题'\n },\n {\n value: '',\n name: '无标题'\n },\n {\n value: '超长标题测试内容，测试超过显示最大范围之后的样式-超长标题测试内容，测试超过显示最大范围之后的样式',\n name: '超长标题'\n }\n ] as ItemType[],\n current: 0\n }\n },\n onLoad() {\n uni.showModal({\n title: \"onLoad 调用示例,请手动取消\",\n showCancel: false\n })\n },\n methods: {\n //自动化测试例专用\n jest_getWindowInfo() : GetWindowInfoResult {\n return uni.getWindowInfo();\n },\n showCancelChange: function (e : UniSwitchChangeEvent) {\n this.showCancelSelect = e.detail.value\n },\n cancelTextChange: function (e : UniSwitchChangeEvent) {\n this.cancelTextSelect = e.detail.value\n },\n confirmTextChange: function (e : UniSwitchChangeEvent) {\n this.confirmTextSelect = e.detail.value\n },\n editableChange: function (e : UniSwitchChangeEvent) {\n this.editableSelect = e.detail.value\n },\n placeholderTextChange: function (e : UniSwitchChangeEvent) {\n this.placeholderTextSelect = e.detail.value\n },\n radioChange(e : UniRadioGroupChangeEvent) {\n for (let i = 0; i < this.items.length; i++) {\n if (this.items[i].value === e.detail.value) {\n this.current = i;\n break;\n }\n }\n },\n modalTap: function () {\n let cancelTextVal : string\n let cancelColorVal = ''\n if (this.cancelTextSelect) {\n cancelTextVal = \"修改后的取消文本\"\n cancelColorVal = \"#ff00ff\"\n } else {\n cancelTextVal = \"取消\"\n }\n\n let confirmTextVal = '确定'\n let confirmColorVal = ''\n if (this.confirmTextSelect) {\n confirmTextVal = \"修改后的确定文本\"\n confirmColorVal = \"#00ffff\"\n }\n\n let placeholderTextVal = ''\n let contentVal = \"弹窗内容，告知当前状态、信息和解决方法，描述文字尽量控制在三行内\"\n if (this.placeholderTextSelect) {\n placeholderTextVal = \"定制提示信息\"\n contentVal = \"\"\n }\n uni.showModal({\n title: this.items[this.current].value,\n editable: this.editableSelect,\n placeholderText: placeholderTextVal,\n content: contentVal,\n showCancel: this.showCancelSelect,\n cancelText: cancelTextVal,\n cancelColor: cancelColorVal,\n confirmText: confirmTextVal,\n confirmColor: confirmColorVal,\n success: (res) => {\n this.exeRet = JSON.stringify(res)\n },\n fail: (res) => {\n this.exeRet = JSON.stringify(res)\n }\n })\n }\n }\n }\n\n```\n:::"},"showToast":{"name":"## uni.showToast(options) @showtoast","description":"显示消息提示框","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ShowToastOptions](#showtoastoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| title | string | 是 | - | - | 提示的内容，长度与 icon 取值有关。 |\n@| icon | \"success\" \\| \"error\" \\| \"fail\" \\| \"exception\" \\| \"loading\" \\| \"none\" | 否 | - | - | icon值说明 success: 显示成功图标，error: 显示错误图标； fail: 显示错误图标，此时title文本无长度显示； exception: 显示异常图标，此时title文本无长度显示； loading: 显示加载图标；none: 不显示图标。 |\n@| image | [string.ImageURIString](/uts/data-type.md#ide-string) \\| null | 否 | - | - | 自定义图标的本地路径（app端暂不支持gif） |\n@| mask | boolean \\| null | 否 | - | - | 是否显示透明蒙层，防止触摸穿透，默认：false |\n@| duration | number \\| null | 否 | - | - | 提示的延迟时间，单位毫秒，默认：1500 |\n@| position | \"top\" \\| \"center\" \\| \"bottom\" | 否 | - | - | position值说明（仅App生效） top: 居上显示； center: 居中显示；bottom： 居底显示 |\n@| success | (res: ShowToastSuccess) => void \\| null | 否 | - | - | uni.showToast成功回调函数定义 |\n@| fail | (res: [IPromptError](#iprompterror-values)) => void \\| null | 否 | - | - | uni.showToast失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.showToast完成回调函数定义 | \n\n##### IPromptError 的属性值 @iprompterror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1 \\| 1001 | 是 | - | - | 错误码
- 1\t 撤销
- 1001 请求参数非法 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### showToast 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showtoast)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.prompt.showToast)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/toast/toast.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/toast/toast\n>Template\n```vue\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: 'toast',\n exeRet: ''\n }\n },\n onLoad() {\n uni.showToast({\n title: 'onLoad 调用示例,2秒后消失'\n })\n setTimeout(function () {\n uni.hideToast()\n }, 2000);\n },\n methods: {\n //自动化测试例专用\n jest_getWindowInfo() : GetWindowInfoResult {\n return uni.getWindowInfo();\n },\n toast1Tap: function () {\n uni.showToast({\n title: \"默认\",\n success: (res) => {\n this.exeRet = \"success:\" + JSON.stringify(res)\n },\n fail: (res) => {\n this.exeRet = \"fail:\" + JSON.stringify(res)\n },\n })\n },\n toastTapIconError: function () {\n uni.showToast({\n title: \"默认\",\n icon: 'error',\n success: (res) => {\n this.exeRet = \"success:\" + JSON.stringify(res)\n },\n fail: (res) => {\n this.exeRet = \"fail:\" + JSON.stringify(res)\n },\n })\n },\n toast2Tap: function () {\n uni.showToast({\n title: \"duration 3000\",\n duration: 3000,\n success: (res) => {\n this.exeRet = \"success:\" + JSON.stringify(res)\n },\n fail: (res) => {\n this.exeRet = \"fail:\" + JSON.stringify(res)\n },\n })\n },\n toast3Tap: function () {\n uni.showToast({\n title: \"loading\",\n icon: \"loading\",\n duration: 5000,\n success: (res) => {\n this.exeRet = \"success:\" + JSON.stringify(res)\n },\n fail: (res) => {\n this.exeRet = \"fail:\" + JSON.stringify(res)\n },\n })\n },\n toast4Tap: function () {\n uni.showToast({\n title: \"logo\",\n image: \"/static/uni.png\",\n success: (res) => {\n this.exeRet = \"success:\" + JSON.stringify(res)\n },\n fail: (res) => {\n this.exeRet = \"fail:\" + JSON.stringify(res)\n },\n })\n },\n // #ifdef APP\n toast5Tap: function () {\n uni.showToast({\n title: \"显示一段轻提示\",\n position: 'bottom',\n success: (res) => {\n this.exeRet = \"success:\" + JSON.stringify(res)\n },\n fail: (res) => {\n this.exeRet = \"fail:\" + JSON.stringify(res)\n },\n })\n },\n // #endif\n hideToast: function () {\n uni.hideToast()\n }\n }\n }\n\n```\n:::"},"loadFontFace":{"name":"## uni.loadFontFace(options) @loadfontface","description":"\n动态加载网络字体\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [LoadFontFaceOptions](#loadfontfaceoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| global | boolean | 否 | - | | 是否全局生效。微信小程序 '2.10.0'起支持全局生效，需在 app.vue 中调用。 |\n@| family | string | 是 | - | | 定义的字体名称 |\n@| source | string | 是 | - | | 字体资源的地址, App-Android 平台不支持 woff、woff2 格式字体文件 |\n@| desc | **LoadFontFaceOptionDesc** | 否 | - | | 可选的字体描述符 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| style | string \\| null | 否 | - | - | |\n@@| weight | string \\| null | 否 | - | - | |\n@@| variant | string \\| null | 否 | - | - | |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | | 接口调用成功的回调函数 |\n@| fail | (error: [LoadFontFaceFail](#loadfontfacefail-values)) => void | 否 | - | | 接口调用失败的回调函数 |\n@| complete | (res: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### LoadFontFaceFail 的属性值 @loadfontfacefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 4 \\| 99 \\| 101 \\| 100001 \\| 100002 \\| 200001 \\| 300001 \\| 300002 | 是 | - | - | 错误码
- 4: 框架内部异常
- 99: page is not ready
- 101: 参数错误
- 100001: family is null
- 100002: source is null
- 200001: local font not found
- 300001: same source task is loading
- 300002: download fail |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### loadFontFace 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | 4.10 | 4.0 |\n","tutorial":"\n### 参见\n- [loadFontFace](https://doc.dcloud.net.cn/uni-app-x/api/load-font-face.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.load-font-face)\n"},"load-font-face":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/load-font-face/load-font-face.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/load-font-face/load-font-face\n>Template\n```vue\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n uniIcon1: '\\ue100',\n uniIcon2: '\\ue101',\n }\n },\n onLoad() {\n uni.loadFontFace({\n global: true,\n family: 'UniFontFamily',\n source: \"url('/static/font/uni.ttf')\",\n success() {\n console.log('global loadFontFace uni.ttf success')\n },\n fail(error) {\n console.warn('global loadFontFace uni.ttf fail', error.errMsg)\n },\n })\n uni.loadFontFace({\n family: 'AlimamaDaoLiTiTTF',\n source:\n \"url('https://qiniu-web-assets.dcloud.net.cn/uni-app-x/static/font/AlimamaDaoLiTi.ttf')\",\n success() {\n console.log('loadFontFace Remote AlimamaDaoLiTi.ttf success')\n },\n fail(error) {\n console.warn('loadFontFace Remote AlimamaDaoLiTi.ttf fail', error.errMsg)\n },\n })\n uni.loadFontFace({\n family: 'AlimamaDaoLiTiOTF',\n source: \"url('/static/font/AlimamaDaoLiTi.otf')\",\n success() {\n console.log('loadFontFace AlimamaDaoLiTi.otf success')\n },\n fail(error) {\n console.warn('loadFontFace AlimamaDaoLiTi.otf fail', error.errMsg)\n },\n })\n uni.loadFontFace({\n family: 'AlimamaDaoLiTiWOFF',\n source: \"url('/static/font/AlimamaDaoLiTi.woff')\",\n success() {\n console.log('loadFontFace AlimamaDaoLiTi.woff success')\n },\n fail(error) {\n console.warn('loadFontFace AlimamaDaoLiTi.woff fail', error.errMsg)\n },\n })\n uni.loadFontFace({\n family: 'AlimamaDaoLiTiWOFF2',\n source: \"url('/static/font/AlimamaDaoLiTi.woff2')\",\n success() {\n console.log('loadFontFace AlimamaDaoLiTi.woff2 success')\n },\n fail(error) {\n console.warn('loadFontFace AlimamaDaoLiTi.woff2 fail', error.errMsg)\n },\n })\n },\n methods: {\n navigateToChild() {\n uni.navigateTo({\n url: '/pages/API/load-font-face/load-font-face-child',\n })\n },\n },\n }\n\n```\n:::"},"rpx2px":{"name":"## uni.rpx2px(number) @rpx2px","description":"\n将rpx单位值转换成px","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| number | number | 是 | - | - | | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| number |\n \n","compatibility":"### rpx2px 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.02 | 4.11 | 4.02 |\n","tutorial":"\n### 参见\n- [rpx2px](https://doc.dcloud.net.cn/uni-app-x/api/rpx2px.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.rpx2px)\n","example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/rpx2px/rpx2px.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/rpx2px/rpx2px\n>Template\n```vue\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: 'rpx2px',\n rpxValue: 750,\n pxValue: 0,\n result: false\n }\n },\n methods: {\n rpx2px: function () {\n this.pxValue = uni.rpx2px(this.rpxValue);\n\n // 仅限自动化测试\n const windowInfo = uni.getWindowInfo();\n if (windowInfo.windowWidth == this.pxValue) {\n this.result = true\n }\n }\n }\n }\n\n```\n:::"},"setAppTheme":{"name":"## uni.setAppTheme(options) @setapptheme","description":"设置应用主题","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SetAppThemeOptions](#setappthemeoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| theme | \"light\" \\| \"dark\" \\| \"auto\" | 是 | - | - | 主题 |\n@| success | (result: SetAppThemeSuccessResult) => void | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [IAppThemeFail](#iappthemefail-values)) => void | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### IAppThemeFail 的属性值 @iappthemefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 702001 \\| 2002000 | 是 | - | - | 错误码
- 702001 参数错误
- 2002000 未知错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### setAppTheme 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | 4.18 | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.theme.setAppTheme)\n"},"onOsThemeChange":{"name":"## uni.onOsThemeChange(callback) @onosthemechange","description":"开启监听系统主题变化","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: [OsThemeChangeResult](#osthemechangeresult-values)) => void | 是 | - | - | | \n\n#### OsThemeChangeResult 的属性值 @osthemechangeresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| osTheme | string | 是 | - | - | 系统主题 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| number |\n \n","compatibility":"### onOsThemeChange 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | 4.18 | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.theme.onOsThemeChange)\n"},"offOsThemeChange":{"name":"## uni.offOsThemeChange(id) @offosthemechange","description":"取消监听系统主题变化","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| id | number | 是 | - | - | | \n","returnValue":"","compatibility":"### offOsThemeChange 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | 4.18 | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.theme.offOsThemeChange)\n"},"onAppThemeChange":{"name":"## uni.onAppThemeChange(callback) @onappthemechange","description":"开启监听应用主题变化","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: [AppThemeChangeResult](#appthemechangeresult-values)) => void | 是 | - | - | | \n\n#### AppThemeChangeResult 的属性值 @appthemechangeresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| appTheme | string | 是 | - | - | 应用主题 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| number |\n \n","compatibility":"### onAppThemeChange 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | 4.18 | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.theme.onAppThemeChange)\n"},"offAppThemeChange":{"name":"## uni.offAppThemeChange(id) @offappthemechange","description":"取消监听应用主题变化","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| id | number | 是 | - | - | | \n","returnValue":"","compatibility":"### offAppThemeChange 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | 4.18 | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.theme.offAppThemeChange)\n"},"request":{"name":"## uni.request(param) @request","description":"发起网络请求。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| param | [RequestOptions\\](#requestoptions-values) | 是 | - | - | 网络请求参数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| url | string | 是 | - | | 开发者服务器接口地址 |\n@| data | any \\| null | 否 | null | | 请求的参数 UTSJSONObject\\|string类型 |\n@| header | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \\| null | 否 | null | | 设置请求的 header，header 中不能设置 Referer |\n@| method | \"GET\" \\| \"POST\" \\| \"PUT\" \\| \"PATCH\" \\| \"DELETE\" \\| \"HEAD\" \\| \"OPTIONS\" | 否 | \"GET\" | | 请求方法
- GET GET方法请求一个指定资源的表示形式，使用 GET 的请求应该只被用于获取数据。
- POST POST方法用于将实体提交到指定的资源，通常导致在服务器上的状态变化或副作用。
- PUT PUT方法用有效载荷请求替换目标资源的所有当前表示。
- PATCH PATCH方法用于对资源应用部分修改。
- DELETE DELETE方法删除指定的资源。
- HEAD HEAD方法请求一个与GET请求的响应相同的响应，但没有响应体。
- OPTIONS OPTIONS 方法用于描述目标资源的通信选项。 |\n@| timeout | number \\| null | 否 | 60000 | | 超时时间，单位 ms |\n@| withCredentials | boolean \\| null | 否 | - | | 跨域请求时是否携带凭证（cookies）
|\n@| success | (option: [RequestSuccess\\](#requestsuccess-values)) => void \\| null | 否 | null | - | 网络请求成功回调。 |\n@| fail | (option: [RequestFail](#requestfail-values)) => void \\| null | 否 | null | - | 网络请求失败回调。 |\n@| complete | (option: any) => void \\| null | 否 | null | - | 网络请求完成回调，成功或者失败都会调用。 | \n\n##### RequestSuccess\\ 的属性值 @requestsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | T \\| null | 否 | - | | 开发者服务器返回的数据 |\n| statusCode | number | 是 | - | | 开发者服务器返回的 HTTP 状态码 |\n| header | any | 是 | - | | 开发者服务器返回的 HTTP Response Header |\n| cookies | Array\\ | 是 | - | | 开发者服务器返回的 cookies，格式为字符串数组 |\n\n##### RequestFail 的属性值 @requestfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 5 \\| 1000 \\| 100001 \\| 100002 \\| 600003 \\| 600009 \\| 602001 | 是 | - | - | 错误码
- 5 接口超时
- 1000 服务端系统错误
- 100001 json数据解析错误
- 100002 错误信息json解析失败
- 600003 网络中断
- 600009 URL格式不合法
- 602001 request系统错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [RequestTask](#requesttask-values) |\n\n#### RequestTask 的方法 @requesttask-values \n\n#### abort() @abort\n中断网络请求。\n\n\n##### abort 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/request.html#request)\n \n","compatibility":"### request 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/request.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.request)\n","example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/request/request.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/request/request\n>Template\n```vue\n\r\n\r\n\n```\n>Script\n```uts\n\n // #ifdef APP\n import {\n testInovkeRequest,\n CommonOptions\n } from '@/uni_modules/test-invoke-network-api'\n // #endif\n\n class GETDataType {\n data: UTSJSONObject | null = null\n }\n\r\n const duration = 2000\r\n const methodMap = {\r\n \"GET\": \"/api/http/method/get\",\r\n \"POST\": \"/api/http/method/post\",\r\n \"PUT\": \"/api/http/method/put\",\r\n \"DELETE\": \"/api/http/method/delete\",\r\n \"PATCH\": \"/api/http/method/patch\",\r\n \"OPTIONS\": \"/api/http/method/options\",\r\n \"HEAD\": \"/api/http/method/head\"\r\n }\r\n\r\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'request',\r\n res: '',\r\n task: null as RequestTask | null,\r\n host: \"https://request.dcloud.net.cn\",\r\n url: \"/api/http/method/get\",\r\n method: \"GET\" as RequestMethod | null,\r\n data: null as any | null,\r\n header: null as UTSJSONObject | null,\r\n errorCodeUrls: [\r\n \"/api/http/statusCode/200\",\r\n \"/api/http/statusCode/204\",\r\n \"/api/http/statusCode/301\",\r\n \"/api/http/statusCode/302\",\r\n \"/api/http/statusCode/307\",\r\n \"/api/http/statusCode/400\",\r\n \"/api/http/statusCode/401\",\r\n \"/api/http/statusCode/403\",\r\n \"/api/http/statusCode/404\",\r\n \"/api/http/statusCode/405\",\r\n \"/api/http/statusCode/500\",\r\n \"/api/http/statusCode/502\",\r\n \"/api/http/statusCode/503\",\r\n \"/api/http/statusCode/504\",\r\n ],\r\n headerUrls: [\r\n \"/api/http/header/ua\",\r\n \"/api/http/header/referer\",\r\n \"/api/http/header/requestCookie\",\r\n \"/api/http/header/setCookie\",\r\n \"/api/http/header/deleteCookie\"\r\n ],\r\n contentTypeUrls: [\r\n \"/api/http/contentType/text/plain\",\r\n \"/api/http/contentType/text/html\",\r\n \"/api/http/contentType/text/xml\",\r\n \"/api/http/contentType/image/gif\",\r\n \"/api/http/contentType/image/jpeg\",\r\n \"/api/http/contentType/image/png\",\r\n \"/api/http/contentType/application/json\",\r\n \"/api/http/contentType/application/octetStream\",\r\n ],\r\n postUrls: [\r\n \"/api/http/contentType/json\",\r\n \"/api/http/contentType/xWwwFormUrlencoded\",\r\n ],\r\n //自动化测试例专用\r\n jest_result: false\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload() {\r\n uni.hideLoading();\r\n this.task?.abort();\r\n },\r\n methods: {\r\n changeMethod(e : RequestMethod) {\r\n this.method = e;\r\n this.url = methodMap[e] as string;\r\n this.data = null;\r\n this.header = null;\r\n },\r\n changeUrl(e : string) {\r\n this.method = \"GET\";\r\n this.url = e;\r\n this.data = null;\r\n this.header = null;\r\n },\r\n changeUrlFromPost(e : string) {\r\n this.method = \"POST\";\r\n this.url = e;\r\n switch (e) {\r\n case \"/api/http/contentType/json\":\r\n this.header = {\r\n \"Content-Type\": \"application/json\"\r\n };\r\n this.data = {\r\n \"hello\": \"world\"\r\n };\r\n break;\r\n case \"/api/http/contentType/xWwwFormUrlencoded\":\r\n this.header = {\r\n \"Content-Type\": \"application/x-www-form-urlencoded\"\r\n };\r\n this.data = \"hello=world\";\r\n break;\r\n }\r\n },\r\n sendRequest() {\r\n uni.showLoading({\r\n title: \"请求中...\"\r\n })\r\n this.task = uni.request({\r\n url: this.host + this.url,\r\n // dataType: \"json\",\r\n // responseType: \"json\",\r\n method: this.method,\r\n data: this.data,\r\n header: this.header,\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: (res) => {\r\n console.log('request success', JSON.stringify(res.data))\r\n console.log('request success header is :', JSON.stringify(res.header))\r\n uni.showToast({\r\n title: '请求成功',\r\n icon: 'success',\r\n mask: true,\r\n duration: duration\r\n });\r\n this.res = '请求结果 : ' + JSON.stringify(res);\r\n },\r\n fail: (err) => {\r\n console.log('request fail', err);\r\n uni.showModal({\r\n content: err.errMsg,\r\n showCancel: false\r\n });\r\n },\r\n complete: () => {\r\n uni.hideLoading()\r\n },\r\n });\r\n },\r\n //自动化测试例专用\r\n jest_request() {\r\n uni.request({\r\n url: this.host + this.url,\r\n // dataType: \"json\",\r\n // responseType: \"json\",\r\n method: this.method,\r\n data: this.data,\r\n header: this.header,\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_result = true;\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_set_cookie() {\r\n uni.request({\r\n url: this.host + \"/api/http/header/setCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_cookie_request(true)\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_delete_cookie() {\r\n uni.request({\r\n url: this.host + \"/api/http/header/deleteCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_cookie_request(false)\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_cookie_request(needCookie : boolean) {\r\n uni.request({\r\n url: this.host + \"/api/http/header/requestCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: (res) => {\n const requestCookie = (res.data as UTSJSONObject).getJSON(\"data\")?.getAny(\"requestCookie\")\r\n console.log(\"requestCookie \", requestCookie);\r\n if (requestCookie instanceof Array) {\r\n this.jest_result = needCookie ? requestCookie.length > 0 : requestCookie.length == 0\r\n } else {\r\n this.jest_result = needCookie ? (requestCookie as UTSJSONObject).toMap().size > 0 : (requestCookie as UTSJSONObject).toMap().size == 0\r\n }\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_timeout_null() {\r\n uni.request({\r\n url: this.host + (methodMap['GET'] as string),\r\n method: \"GET\",\r\n timeout: null,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\n this.jest_result = true;\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\n jest_get_with_data() {\n uni.request({\n url: \"https://unidemo.dcloud.net.cn/api/banner/36kr\",\n method: \"GET\",\n data:{\n column: 'id,post_id,title,author_name,cover,published_at' //需要的字段名\n },\n timeout: 6000,\n sslVerify: false,\n withCredentials: false,\n firstIpv4: false,\n success: () => {\n this.jest_result = true;\n },\n fail: () => {\n this.jest_result = false;\n },\n });\n },\n jest_get_with_generics() {\n uni.request({\n url: this.host + (methodMap['GET'] as string),\n method: \"GET\",\n timeout: null,\n sslVerify: false,\n withCredentials: false,\n firstIpv4: false,\n success: (res: RequestSuccess) => {\n console.log(\"success :\", res.data?.data);\n this.jest_result = true;\n },\n fail: () => {\n this.jest_result = false;\n },\n });\n },\n jest_get_array() {\n uni.request({\n url: 'https://unidemo.dcloud.net.cn/api/news?column=title,author_name,cover,published_at',\n method: \"GET\",\n success: (res : RequestSuccess) => {\n console.log(res)\n if (res.statusCode == 200 && Array.isArray(res.data)) {\n this.jest_result = true\n } else {\n this.jest_result = false\n }\n },\n fail: () => {\n this.jest_result = false\n }\n });\n },\n jest_uts_module_invoked(){\n // #ifdef APP\n testInovkeRequest({\n success:(res: any)=>{\n console.log(\"success :\", res);\n this.jest_result = true\n },\n fail:(err: any)=>{\n console.log(\"fail :\", err);\n this.jest_result = false\n }\n } as CommonOptions)\n // #endif\n }\r\n }\r\n }\r\n\n```\n:::"},"uploadFile":{"name":"## uni.uploadFile(options) @uploadfile","description":"将本地资源上传到开发者服务器。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [UploadFileOptions](#uploadfileoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| url | string | 是 | - | | 开发者服务器 url |\n@| filePath | string \\| null | 否 | null | | 要上传文件资源的路径, 支持uni.env |\n@| name | string \\| null | 否 | null | | 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容 |\n@| files | Array\\<**UploadFileOptionFiles**\\> \\| null | 否 | null | | 需要上传的文件列表。 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| name | string \\| null | 否 | \"file\" | | multipart 提交时，表单的项目名，默认为 file，如果 name 不填或填的值相同，可能导致服务端读取文件时只能读取到一个文件。 |\n@@| uri | string | 是 | - | | 要上传文件资源的路径 |\n@@| file | any \\| null | 否 | - | | 要上传的文件对象 |\n@| header | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \\| null | 否 | null | | HTTP 请求 Header, header 中不能设置 Referer |\n@| formData | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \\| null | 否 | null | | HTTP 请求中其他额外的 form data |\n@| timeout | number \\| null | 否 | 120000 | | 超时时间，单位 ms |\n@| success | (result: [UploadFileSuccess](#uploadfilesuccess-values)) => void \\| null | 否 | null | - | 成功返回的回调函数 |\n@| fail | (result: [UploadFileFail](#uploadfilefail-values)) => void \\| null | 否 | null | - | 失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 结束的回调函数（调用成功、失败都会执行） | \n\n##### UploadFileSuccess 的属性值 @uploadfilesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | string | 是 | - | | 开发者服务器返回的数据 |\n| statusCode | number | 是 | - | | 开发者服务器返回的 HTTP 状态码 |\n\n##### UploadFileFail 的属性值 @uploadfilefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 5 \\| 1000 \\| 100001 \\| 100002 \\| 600003 \\| 600009 \\| 602001 | 是 | - | - | 错误码
- 5 接口超时
- 1000 服务端系统错误
- 100001 json数据解析错误
- 100002 错误信息json解析失败
- 600003 网络中断
- 600009 URL格式不合法
- 602001 request系统错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [UploadTask](#uploadtask-values) |\n\n#### UploadTask 的方法 @uploadtask-values \n\n#### abort() @abort\n中断上传任务。\n\n\n##### abort 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/network-file.html#uploadfile)\n\n#### onProgressUpdate(callback) @onprogressupdate\n监听上传进度变化。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [OnProgressUpdateResult](#onprogressupdateresult-values)) => void | 是 | - | - | | \n\n##### OnProgressUpdateResult 的属性值 @onprogressupdateresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| progress | number | 是 | - | | 上传进度百分比 |\n| totalBytesSent | number | 是 | - | | 已经上传的数据长度，单位 Bytes |\n| totalBytesExpectedToSend | number | 是 | - | | 预期需要上传的数据总长度，单位 Bytes |\n\n\n##### onProgressUpdate 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/network-file.html#uploadfile)\n \n","compatibility":"### uploadFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/network-file.html#uploadfile)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.upload-file)\n"},"upload-file":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/upload-file/upload-file.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/upload-file/upload-file\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\n // #ifdef APP\n import {\n testInovkeUploadFile,\n CommonOptions\n } from '@/uni_modules/test-invoke-network-api'\n // #endif\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'uploadFile',\r\n imageSrc: '',\r\n task: null as UploadTask | null,\r\n //自动化测试例专用\r\n jest_result: false,\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload() {\r\n this.imageSrc = '';\r\n uni.hideLoading();\r\n this.task?.abort();\r\n },\r\n methods: {\r\n chooseImage: function () {\r\n uni.chooseImage({\r\n count: 1,\r\n sizeType: ['compressed'],\r\n sourceType: ['album'],\r\n success: (res) => {\r\n console.log('chooseImage success, temp path is', res.tempFilePaths[0])\r\n var imageSrc = res.tempFilePaths[0]\r\n uni.showLoading({\r\n title: '上传中'\r\n })\r\n this.task = uni.uploadFile({\r\n url: 'https://unidemo.dcloud.net.cn/upload', //仅为示例，非真实的接口地址\r\n filePath: imageSrc,\r\n name: 'file',\r\n formData: {\r\n 'user': 'test'\r\n },\r\n success: (res) => {\r\n console.log('uploadImage success, res is:', res)\r\n uni.hideLoading();\r\n uni.showToast({\r\n title: '上传成功',\r\n icon: 'success',\r\n duration: 1000\r\n })\r\n this.imageSrc = imageSrc\r\n },\r\n fail: (err) => {\r\n console.log('uploadImage fail', err);\r\n uni.hideLoading();\r\n uni.showModal({\r\n content: err.errMsg,\r\n showCancel: false\r\n });\r\n },\r\n });\r\n },\r\n fail: (err) => {\r\n console.log('chooseImage fail', err)\r\n }\r\n })\r\n },\r\n //自动化测试例专用\r\n jest_uploadFile() {\r\n const imageSrc = \"/static/uni.png\";\r\n this.task = uni.uploadFile({\r\n url: 'https://unidemo.dcloud.net.cn/upload', //仅为示例，非真实的接口地址\r\n filePath: imageSrc,\r\n name: 'file',\r\n formData: {\r\n 'user': 'test'\r\n },\r\n success: () => {\r\n this.jest_result = true;\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n })\r\n },\r\n jest_set_cookie() {\r\n uni.request({\r\n url: \"https://request.dcloud.net.cn/api/http/header/setCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_cookie_upload(true)\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n\r\n jest_delete_cookie() {\r\n uni.request({\r\n url: \"https://request.dcloud.net.cn/api/http/header/deleteCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_cookie_upload(false)\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_cookie_upload(needCookie : boolean) {\r\n const imageSrc = \"/static/uni.png\";\r\n this.task = uni.uploadFile({\r\n url: 'https://request.dcloud.net.cn/api/http/header/upload',\r\n filePath: imageSrc,\r\n name: 'file',\r\n success: (res : UploadFileSuccess) => {\r\n const data = JSON.parseObject(res.data)\r\n const errCode = data?.getNumber(\"errCode\")\r\n if (errCode != null && errCode == 1000) {\r\n this.jest_result = needCookie ? false : true;\r\n } else {\r\n this.jest_result = needCookie ? true : false;\r\n }\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n })\r\n },\r\n jest_files_upload() {\r\n const imageSrc = \"/static/uni.png\";\r\n this.task = uni.uploadFile({\r\n url: 'https://unidemo.dcloud.net.cn/upload',\r\n files: [\r\n {\r\n name: \"file1\",\r\n uri: imageSrc\r\n } as UploadFileOptionFiles,\r\n {\r\n name: \"file2\",\r\n uri: imageSrc\r\n } as UploadFileOptionFiles\r\n ],\r\n success: (res : UploadFileSuccess) => {\r\n if (res.statusCode == 200) {\r\n this.jest_result = true;\r\n }\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n })\r\n },\n jest_uts_module_invoked(){\n // #ifdef APP\n testInovkeUploadFile({\n success:(res: any)=>{\n console.log(\"success :\", res);\n this.jest_result = true\n },\n fail:(err: any)=>{\n console.log(\"fail :\", err);\n this.jest_result = false\n }\n } as CommonOptions)\n // #endif\n }\r\n }\r\n }\r\n\n```\n:::"},"downloadFile":{"name":"## uni.downloadFile(options) @downloadfile","description":"下载文件资源到本地，客户端直接发起一个 HTTP GET 请求，返回文件的本地临时路径。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [DownloadFileOptions](#downloadfileoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| url | string | 是 | - | | 下载资源的 url |\n@| header | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \\| null | 否 | null | | HTTP 请求 Header，header 中不能设置 Referer |\n@| filePath | string \\| null | 否 | null | | 指定文件下载路径
支持相对路径与绝对路径，例：
`/imgs/pic.png`、`/storage/emulated/0/Android/data/io.dcloud.HBuilder/apps/HBuilder/temp/imgs/pic.png`
并且支持指定下载目录，例：
`/imgs/`
支持uni.env的平台兼容性：Android自3.9开始支持uni.env，iOS自4.13开始支持uni.env |\n@| timeout | number \\| null | 否 | 120000 | | 超时时间，单位 ms |\n@| success | (result: [DownloadFileSuccess](#downloadfilesuccess-values)) => void \\| null | 否 | null | - | 下载成功后以 tempFilePath 的形式传给页面，res = {tempFilePath: '文件的临时路径'} |\n@| fail | (result: [DownloadFileFail](#downloadfilefail-values)) => void \\| null | 否 | null | - | 失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 结束的回调函数（调用成功、失败都会执行） | \n\n##### DownloadFileSuccess 的属性值 @downloadfilesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tempFilePath | string | 是 | - | | 临时文件路径，下载后的文件会存储到一个临时文件 |\n| statusCode | number | 是 | - | | 开发者服务器返回的 HTTP 状态码 |\n\n##### DownloadFileFail 的属性值 @downloadfilefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 5 \\| 1000 \\| 100001 \\| 100002 \\| 600003 \\| 600009 \\| 602001 | 是 | - | - | 错误码
- 5 接口超时
- 1000 服务端系统错误
- 100001 json数据解析错误
- 100002 错误信息json解析失败
- 600003 网络中断
- 600009 URL格式不合法
- 602001 request系统错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [DownloadTask](#downloadtask-values) |\n\n#### DownloadTask 的方法 @downloadtask-values \n\n#### abort() @abort\n中断下载任务。\n\n\n##### abort 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/network-file.html#downloadfile)\n\n#### onProgressUpdate(callback) @onprogressupdate\n监听下载进度变化。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [OnProgressDownloadResult](#onprogressdownloadresult-values)) => void | 是 | - | - | | \n\n##### OnProgressDownloadResult 的属性值 @onprogressdownloadresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| progress | number | 是 | - | | 下载进度百分比 |\n| totalBytesWritten | number | 是 | - | | 已经下载的数据长度，单位 Bytes |\n| totalBytesExpectedToWrite | number | 是 | - | | 预期需要下载的数据总长度，单位 Bytes |\n\n\n##### onProgressUpdate 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/network-file.html#downloadfile)\n \n","compatibility":"### downloadFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/network-file.html#downloadfile)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.download-file)\n"},"download-file":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/download-file/download-file.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/download-file/download-file\n>Template\n```vue\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\n\n // #ifdef APP\n import {\n testInovkeDownloadFile,\n CommonOptions\n } from '@/uni_modules/test-invoke-network-api'\n // #endif\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'downloadFile',\r\n imageSrc: '',\r\n task: null as DownloadTask | null,\r\n //自动化测试例专用\r\n jest_result: false\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload() {\r\n // this.imageSrc = '';\r\n uni.hideLoading();\r\n this.task?.abort();\r\n },\r\n methods: {\r\n downloadImage: function () {\r\n uni.showLoading({\r\n title: '下载中'\r\n })\r\n var self = this\r\n this.task = uni.downloadFile({\r\n url: \"https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni-app.png\",\r\n success: (res) => {\r\n console.log('downloadFile success, res is', res.tempFilePath)\r\n self.imageSrc = res.tempFilePath;\r\n uni.hideLoading();\r\n },\r\n fail: (err) => {\r\n console.log('downloadFile fail, err is:', err)\r\n uni.hideLoading();\r\n }\r\n });\r\n this.task?.onProgressUpdate((update) => {\r\n console.log(\"progress : \", update.progress);\r\n })\r\n },\r\n //自动化测试例专用\r\n jest_downloadFile() {\r\n uni.downloadFile({\r\n url: \"https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni-app.png\",\r\n success: () => {\r\n this.jest_result = true\r\n },\r\n fail: () => {\r\n this.jest_result = false\r\n }\r\n });\r\n },\n\n jest_downloadFile_with_uni_env() {\n uni.downloadFile({\n url: \"https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni-app.png\",\n filePath: `${uni.env.CACHE_PATH}/a/b/`,\n success: () => {\n this.jest_result = true\n },\n fail: () => {\n this.jest_result = false\n }\n });\n },\n\n jest_set_cookie(){\n uni.request({\n url: \"https://request.dcloud.net.cn/api/http/header/setCookie\",\n method: \"GET\",\n timeout: 6000,\n sslVerify: false,\n withCredentials: true,\n firstIpv4: false,\n success: () => {\n this.jest_cookie_download(true)\n },\n fail: () => {\n this.jest_result = false;\n },\n });\n },\n\n jest_delete_cookie(){\n uni.request({\n url: \"https://request.dcloud.net.cn/api/http/header/deleteCookie\",\n method: \"GET\",\n timeout: 6000,\n sslVerify: false,\n withCredentials: true,\n firstIpv4: false,\n success: () => {\n this.jest_cookie_download(false)\n },\n fail: () => {\n this.jest_result = false;\n },\n });\n },\n jest_cookie_download(needCookie: boolean){\n uni.downloadFile({\n url: \"https://request.dcloud.net.cn/api/http/header/download\",\n success: () => {\n this.jest_result = needCookie ? true : false;\n },\n fail: () => {\n this.jest_result = needCookie ? false : true;\n }\n });\n },\n jest_uts_module_invoked(){\n // #ifdef APP\n testInovkeDownloadFile({\n success:(res: any)=>{\n console.log(\"success :\", res);\n this.jest_result = true\n },\n fail:(err: any)=>{\n console.log(\"fail :\", err);\n this.jest_result = false\n }\n } as CommonOptions)\n // #endif\n }\r\n }\r\n }\r\n\n```\n:::"},"getNetworkType":{"name":"## uni.getNetworkType(options) @getnetworktype","description":"获取网络类型","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetNetworkTypeOptions](#getnetworktypeoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (result: [GetNetworkTypeSuccess](#getnetworktypesuccess-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetNetworkTypeSuccess 的属性值 @getnetworktypesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| networkType | string | 是 | - | - | 网络类型 |\n","returnValue":"","compatibility":"### getNetworkType 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/system/network?id=getnetworktype)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.get-network-type)\n"},"get-network-type":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-network-type/get-network-type.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-network-type/get-network-type\n>Template\n```vue\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'getNetworkType',\r\n hasNetworkType: false,\r\n networkType: '',\r\n connectedWifi: '',\r\n //自动化测试例专用\r\n jest_result: false,\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload: function () {\r\n this.networkType = '';\r\n this.hasNetworkType = false;\r\n },\r\n methods: {\r\n getNetworkType: function () {\r\n uni.getNetworkType({\r\n success: (res) => {\r\n console.log(res)\r\n this.hasNetworkType = true;\r\n this.networkType = res.networkType\r\n },\r\n fail: () => {\r\n uni.showModal({\r\n content: '获取失败！',\r\n showCancel: false\r\n })\r\n }\r\n })\r\n },\r\n clear: function () {\r\n this.hasNetworkType = false;\r\n this.networkType = '';\r\n this.connectedWifi = '';\r\n },\r\n //自动化测试例专用\r\n jest_getNetworkType() {\r\n uni.getNetworkType({\r\n success: () => {\r\n this.jest_result = true;\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n }\r\n })\r\n }\r\n }\r\n }\r\n\n```\n:::"},"connectSocket":{"name":"## connectSocket(options) @connectsocket","description":"创建一个 WebSocket 连接。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ConnectSocketOptions](#connectsocketoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| url | string | 是 | - | | 开发者服务器接口地址 |\n@| header | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \\| null | 否 | null | | 如果属性名存在，且类型为UTSJSONObject返回对应的结果，不存在返回null |\n@| protocols | Array\\ \\| null | 否 | null | | 子协议数组 |\n@| success | (result: [ConnectSocketSuccess](#connectsocketsuccess-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [ConnectSocketFail](#connectsocketfail-values)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### ConnectSocketSuccess 的属性值 @connectsocketsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n\n##### ConnectSocketFail 的属性值 @connectsocketfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | 错误码 - 600009 URL格式不合法 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [SocketTask](#sockettask-values) |\n\n#### SocketTask 的方法 @sockettask-values \n\n#### send(options) @send\n通过 WebSocket 连接发送数据\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SendSocketMessageOptions](#sendsocketmessageoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| data | any | 是 | - | | 需要发送的内容 |\n@| success | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [SendSocketMessageFail](#sendsocketmessagefail-values)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SendSocketMessageFail 的属性值 @sendsocketmessagefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 10001 \\| 10002 \\| 602001 | 是 | - | - | 错误码
- 10001 发送数据超限，发送队列不能超过16M大小。
- 10002 websocket未连接
- 602001 websocket系统错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n\n##### send 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-send)\n\n#### close(options) @close\n关闭 WebSocket 连接\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **CloseSocketOptions** | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| code | number \\| null | 否 | 1000 | | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。如果这个参数没有被指定，默认的取值是1000 （表示正常连接关闭） |\n@| reason | string \\| null | 否 | \"\" | | 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本（不是字符） |\n@| success | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### close 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-close)\n\n#### onOpen(callback) @onopen\n监听 WebSocket 连接打开事件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | **OnSocketOpenCallbackResult** | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| header | any | 是 | - | | 连接成功的 HTTP 响应 Header | \n\n\n##### onOpen 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-onopen)\n\n#### onClose(callback) @onclose\n监听 WebSocket 连接关闭事件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: any) => void | 是 | - | - | | \n\n\n##### onClose 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-onclose)\n\n#### onError(callback) @onerror\n监听 WebSocket 错误\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void | 是 | - | - | | \n\n\n##### onError 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-onerror)\n\n#### onMessage(callback) @onmessage\n监听 WebSocket 接受到服务器的消息事件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [OnSocketMessageCallbackResult](#onsocketmessagecallbackresult-values)) => void | 是 | - | - | | \n\n##### OnSocketMessageCallbackResult 的属性值 @onsocketmessagecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | any | 是 | - | | 服务器返回的消息 |\n\n\n##### onMessage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-onmessage)\n \n","compatibility":"### connectSocket 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/websocket.html#connectsocket)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.connectSocket)\n"},"onSocketOpen":{"name":"## onSocketOpen(options) @onsocketopen","description":"监听WebSocket连接打开事件。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | (result: [OnSocketOpenCallbackResult](#onsocketopencallbackresult-values)) => void | 是 | - | - | | \n","returnValue":"","compatibility":"### onSocketOpen 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketopen)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.onSocketOpen)\n"},"onSocketError":{"name":"## onSocketError(callback) @onsocketerror","description":"下载文件资源到本地，客户端直接发起一个 HTTP GET 请求，返回文件的本地临时路径。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [OnSocketErrorCallbackResult](#onsocketerrorcallbackresult-values)) => void | 是 | - | - | | \n\n#### OnSocketErrorCallbackResult 的属性值 @onsocketerrorcallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | 错误信息 |\n","returnValue":"","compatibility":"### onSocketError 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketerror)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.onSocketError)\n"},"sendSocketMessage":{"name":"## sendSocketMessage(options) @sendsocketmessage","description":"通过 WebSocket 连接发送数据，需要先 uni.connectSocket，并在 uni.onSocketOpen 回调之后才能发送。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SendSocketMessageOptions](#sendsocketmessageoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| data | any | 是 | - | | 需要发送的内容 |\n@| success | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [SendSocketMessageFail](#sendsocketmessagefail-values)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SendSocketMessageFail 的属性值 @sendsocketmessagefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 10001 \\| 10002 \\| 602001 | 是 | - | - | 错误码
- 10001 发送数据超限，发送队列不能超过16M大小。
- 10002 websocket未连接
- 602001 websocket系统错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### sendSocketMessage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/websocket.html#sendsocketmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.sendSocketMessage)\n"},"onSocketMessage":{"name":"## onSocketMessage(callback) @onsocketmessage","description":"监听WebSocket接受到服务器的消息事件。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [OnSocketMessageCallbackResult](#onsocketmessagecallbackresult-values)) => void | 是 | - | - | | \n\n#### OnSocketMessageCallbackResult 的属性值 @onsocketmessagecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | any | 是 | - | | 服务器返回的消息 |\n","returnValue":"","compatibility":"### onSocketMessage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.onSocketMessage)\n"},"closeSocket":{"name":"## closeSocket(options) @closesocket","description":"关闭 WebSocket 连接。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **CloseSocketOptions** | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| code | number \\| null | 否 | 1000 | | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。如果这个参数没有被指定，默认的取值是1000 （表示正常连接关闭） |\n@| reason | string \\| null | 否 | \"\" | | 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本（不是字符） |\n@| success | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n","returnValue":"","compatibility":"### closeSocket 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/websocket.html#closesocket)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.closeSocket)\n"},"onSocketClose":{"name":"## onSocketClose(callback) @onsocketclose","description":"监听WebSocket关闭。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [OnSocketCloseCallbackResult](#onsocketclosecallbackresult-values)) => void | 是 | - | - | | \n\n#### OnSocketCloseCallbackResult 的属性值 @onsocketclosecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| code | number | 是 | - | | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。 |\n| reason | string | 是 | - | | 一个可读的字符串，表示连接被关闭的原因。\t |\n","returnValue":"","compatibility":"### onSocketClose 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketclose)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.onSocketClose)\n"},"websocket-global":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/websocket-global/websocket-global.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/websocket-global/websocket-global\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n connected: false,\r\n connecting: false,\r\n msg: '',\r\n roomId: '',\r\n platform: '',\r\n }\r\n },\r\n computed: {\r\n showMsg() : string {\r\n if (this.connected) {\r\n if (this.msg.length > 0) {\r\n return '收到消息：' + this.msg\r\n } else {\r\n return '等待接收消息'\r\n }\r\n } else {\r\n return '尚未连接'\r\n }\r\n },\r\n },\r\n onLoad() {\r\n this.platform = uni.getSystemInfoSync().platform\r\n },\r\n onUnload() {\r\n uni.closeSocket({\r\n code: 1000,\r\n reason: 'close reason from client',\r\n success: (res : any) => {\r\n console.log('uni.closeSocket success', res)\r\n },\r\n fail: (err : any) => {\r\n console.log('uni.closeSocket fail', err)\r\n },\r\n } as CloseSocketOptions)\r\n uni.hideLoading()\r\n },\r\n methods: {\r\n connect() {\r\n if (this.connected || this.connecting) {\r\n uni.showModal({\r\n content: '正在连接或者已经连接，请勿重复连接',\r\n showCancel: false,\r\n })\r\n return\r\n }\r\n this.connecting = true\r\n uni.showLoading({\r\n title: '连接中...',\r\n })\r\n uni.connectSocket({\r\n url: 'ws://websocket.dcloud.net.cn',\r\n header: null,\r\n protocols: null,\r\n success: (res : any) => {\r\n // 这里是接口调用成功的回调，不是连接成功的回调，请注意\r\n console.log('uni.connectSocket success', res)\r\n },\r\n fail: (err : any) => {\r\n // 这里是接口调用失败的回调，不是连接失败的回调，请注意\r\n console.log('uni.connectSocket fail', err)\r\n },\r\n })\r\n uni.onSocketOpen((res) => {\r\n this.connecting = false\r\n this.connected = true\r\n uni.hideLoading()\r\n\r\n uni.showToast({\r\n icon: 'none',\r\n title: '连接成功',\r\n })\r\n console.log('onOpen', res)\r\n })\r\n uni.onSocketError((err) => {\r\n this.connecting = false\r\n this.connected = false\r\n uni.hideLoading()\r\n\r\n uni.showModal({\r\n content: '连接失败，可能是websocket服务不可用，请稍后再试',\r\n showCancel: false,\r\n })\r\n console.log('onError', err)\r\n })\r\n uni.onSocketMessage((res) => {\r\n this.msg = res.data as string\r\n console.log('onMessage', res)\r\n })\r\n uni.onSocketClose((res) => {\r\n this.connected = false\r\n this.msg = ''\r\n console.log('onClose', res)\r\n })\r\n },\r\n send() {\r\n uni.sendSocketMessage({\r\n data:\r\n 'from ' +\r\n this.platform +\r\n ' : ' +\r\n parseInt((Math.random() * 10000).toString()).toString(),\r\n success: (res : any) => {\r\n console.log(res)\r\n },\r\n fail: (err : any) => {\r\n console.log(err)\r\n },\r\n } as SendSocketMessageOptions)\r\n },\r\n close() {\r\n uni.closeSocket({\r\n code: 1000,\r\n reason: 'close reason from client',\r\n success: (res : any) => {\r\n console.log('uni.closeSocket success', res)\r\n },\r\n fail: (err : any) => {\r\n console.log('uni.closeSocket fail', err)\r\n },\r\n } as CloseSocketOptions)\r\n },\r\n },\r\n }\r\n\n```\n:::"},"getSystemInfo":{"name":"## uni.getSystemInfo(options) @getsysteminfo","description":"异步获取系统信息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetSystemInfoOptions](#getsysteminfooptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (result: [GetSystemInfoResult](#getsysteminforesult-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetSystemInfoResult 的属性值 @getsysteminforesult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| SDKVersion | string | 是 | - | | 客户端基础库版本 |\n| appId | string | 是 | - | | `manifest.json` 中应用appid。 |\n| appLanguage | string | 是 | - | | 应用设置的语言。 |\n| appName | string | 是 | - | | `manifest.json` 中应用名称。 |\n| appVersion | string | 是 | - | | `manifest.json` 中应用版本名称。 |\n| appVersionCode | string | 是 | - | | `manifest.json` 中应用版本名号。 |\n| ~~brand~~ | string | 是 | - | | 手机品牌。 **已废弃，仅为了向下兼容保留** |\n| browserName | string | 是 | - | | 浏览器名称。`App` 端是系统 webview 的名字，比如 wkwebview、chrome。小程序端为空 |\n| browserVersion | string | 是 | - | | 浏览器版本、webview 版本。 |\n| deviceId | string | 是 | - | | 设备 ID |\n| deviceBrand | string | 是 | - | | 设备品牌。如：`apple`、`huawei`。 |\n| deviceModel | string | 是 | - | | 设备型号 |\n| deviceType | \"phone\" \\| \"pad\" \\| \"tv\" \\| \"watch\" \\| \"pc\" \\| \"undefined\" \\| \"car\" \\| \"vr\" \\| \"appliance\" | 是 | - | | 设备类型。
|\n| devicePixelRatio | number | 是 | - | | 设备像素比 |\n| deviceOrientation | \"portrait\" \\| \"landscape\" | 是 | - | | 设备方向。 |\n| ~~language~~ | string | 是 | - | | 程序设置的语言 **已废弃，仅为了向下兼容保留** |\n| ~~model~~ | string | 是 | - | | 手机型号 **已废弃，仅为了向下兼容保留** |\n| osName | \"ios\" \\| \"android\" \\| \"macos\" \\| \"windows\" \\| \"linux\" | 是 | - | | 系统名称\t
|\n| osVersion | string | 是 | - | | 操作系统版本。如 ios 版本，andriod 版本 |\n| osLanguage | string | 是 | - | | 操作系统语言 |\n| osTheme | \"light\" \\| \"dark\" | 否 | - | | 操作系统主题
|\n| ~~pixelRatio~~ | number | 是 | - | | 设备像素比 **已废弃，仅为了向下兼容保留** |\n| ~~platform~~ | \"ios\" \\| \"android\" \\| \"mac\" \\| \"windows\" \\| \"linux\" | 是 | - | | 客户端平台 **已废弃，仅为了向下兼容保留** |\n| screenWidth | number | 是 | - | | 屏幕宽度，单位为px |\n| screenHeight | number | 是 | - | | 屏幕高度，单位为px |\n| statusBarHeight | number | 是 | - | | 状态栏的高度，单位为px |\n| ~~system~~ | string | 是 | - | | 操作系统版本 **已废弃，仅为了向下兼容保留** |\n| safeArea | **SafeArea** | 是 | - | | 在竖屏正方向下的安全区域 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| left | number | 是 | - | | 安全区域左上角横坐标，单位为px |\n@| right | number | 是 | - | | 安全区域右下角横坐标，单位为px |\n@| top | number | 是 | - | | 安全区域左上角纵坐标，单位为px |\n@| bottom | number | 是 | - | | 安全区域右下角纵坐标，单位为px |\n@| width | number | 是 | - | | 安全区域的宽度，单位为px |\n@| height | number | 是 | - | | 安全区域的高度，单位为px |\n| safeAreaInsets | **SafeAreaInsets** | 是 | - | | 在竖屏正方向下的安全区域插入位置 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| left | number | 是 | - | | 安全区域左侧插入位置，单位为px |\n@| right | number | 是 | - | | 安全区域右侧插入位置，单位为px |\n@| top | number | 是 | - | | 安全区顶部插入位置，单位为px |\n@| bottom | number | 是 | - | | 安全区域底部插入位置，单位为px |\n| ua | string | 是 | - | | 用户标识。小程序端为空 |\n| ~~uniCompileVersion~~ | string | 是 | - | | uni 编译器版本。 **已废弃，仅为了向下兼容保留** |\n| uniCompilerVersion | string | 是 | - | | uni 编译器版本。 |\n| uniPlatform | \"app\" \\| \"web\" \\| \"mp-weixin\" \\| \"mp-alipay\" \\| \"mp-baidu\" \\| \"mp-toutiao\" \\| \"mp-lark\" \\| \"mp-qq\" \\| \"mp-kuaishou\" \\| \"mp-jd\" \\| \"mp-360\" \\| \"quickapp-webview\" \\| \"quickapp-webview-union\" \\| \"quickapp-webview-huawei\" | 是 | - | | uni-app 运行平台，与条件编译平台相同。
|\n| uniRuntimeVersion | string | 是 | - | | uni 运行时版本。 |\n| ~~uniCompileVersionCode~~ | number | 是 | - | | uni 编译器版本号。 **已废弃，仅为了向下兼容保留** |\n| uniCompilerVersionCode | number | 是 | - | | uni 编译器版本号。 |\n| uniRuntimeVersionCode | number | 是 | - | | uni 运行时版本号。 |\n| ~~version~~ | string | 是 | - | | 引擎版本号。 **已废弃，仅为了向下兼容保留** |\n| romName | string | 是 | - | | rom 名称。Android 部分机型获取不到值。iOS 恒为 `ios` |\n| romVersion | string | 是 | - | | rom 版本号。Android 部分机型获取不到值。iOS 为操作系统版本号（同 `osVersion`）。 |\n| windowWidth | number | 是 | - | | 可使用窗口宽度，单位为px |\n| windowHeight | number | 是 | - | | 可使用窗口高度，单位为px |\n| windowTop | number | 是 | - | | 内容区域距离顶部的距离（同CSS变量 `--window-top`），单位为px |\n| windowBottom | number | 是 | - | | 内容区域距离底部的距离（同CSS变量 `--window-bottom`），单位为px |\n| osAndroidAPILevel | number \\| null | 否 | - | | Android 系统API库的版本。
|\n| appTheme | \"light\" \\| \"dark\" \\| \"auto\" | 否 | - | | 当前App的主题
|\n","returnValue":"","compatibility":"### getSystemInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/system/info?id=getsysteminfo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-system-info.getSystemInfo)\n"},"getSystemInfoSync":{"name":"## uni.getSystemInfoSync() @getsysteminfosync","description":"同步获取系统信息","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **GetSystemInfoResult** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| SDKVersion | string | 是 | - | | 客户端基础库版本 |\n@| appId | string | 是 | - | | `manifest.json` 中应用appid。 |\n@| appLanguage | string | 是 | - | | 应用设置的语言。 |\n@| appName | string | 是 | - | | `manifest.json` 中应用名称。 |\n@| appVersion | string | 是 | - | | `manifest.json` 中应用版本名称。 |\n@| appVersionCode | string | 是 | - | | `manifest.json` 中应用版本名号。 |\n@| ~~brand~~ | string | 是 | - | | 手机品牌。 **已废弃，仅为了向下兼容保留** |\n@| browserName | string | 是 | - | | 浏览器名称。`App` 端是系统 webview 的名字，比如 wkwebview、chrome。小程序端为空 |\n@| browserVersion | string | 是 | - | | 浏览器版本、webview 版本。 |\n@| deviceId | string | 是 | - | | 设备 ID |\n@| deviceBrand | string | 是 | - | | 设备品牌。如：`apple`、`huawei`。 |\n@| deviceModel | string | 是 | - | | 设备型号 |\n@| deviceType | \"phone\" \\| \"pad\" \\| \"tv\" \\| \"watch\" \\| \"pc\" \\| \"null\" \\| \"car\" \\| \"vr\" \\| \"appliance\" | 是 | - | | 设备类型。
|\n@| devicePixelRatio | number | 是 | - | | 设备像素比 |\n@| deviceOrientation | \"portrait\" \\| \"landscape\" | 是 | - | | 设备方向。 |\n@| ~~language~~ | string | 是 | - | | 程序设置的语言 **已废弃，仅为了向下兼容保留** |\n@| ~~model~~ | string | 是 | - | | 手机型号 **已废弃，仅为了向下兼容保留** |\n@| osName | \"ios\" \\| \"android\" \\| \"macos\" \\| \"windows\" \\| \"linux\" | 是 | - | | 系统名称\t
|\n@| osVersion | string | 是 | - | | 操作系统版本。如 ios 版本，andriod 版本 |\n@| osLanguage | string | 是 | - | | 操作系统语言 |\n@| osTheme | \"light\" \\| \"dark\" | 否 | - | | 操作系统主题
|\n@| ~~pixelRatio~~ | number | 是 | - | | 设备像素比 **已废弃，仅为了向下兼容保留** |\n@| ~~platform~~ | \"ios\" \\| \"android\" \\| \"mac\" \\| \"windows\" \\| \"linux\" | 是 | - | | 客户端平台 **已废弃，仅为了向下兼容保留** |\n@| screenWidth | number | 是 | - | | 屏幕宽度，单位为px |\n@| screenHeight | number | 是 | - | | 屏幕高度，单位为px |\n@| statusBarHeight | number | 是 | - | | 状态栏的高度，单位为px |\n@| ~~system~~ | string | 是 | - | | 操作系统版本 **已废弃，仅为了向下兼容保留** |\n@| safeArea | **SafeArea** | 是 | - | | 在竖屏正方向下的安全区域 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| left | number | 是 | - | | 安全区域左上角横坐标，单位为px |\n@@| right | number | 是 | - | | 安全区域右下角横坐标，单位为px |\n@@| top | number | 是 | - | | 安全区域左上角纵坐标，单位为px |\n@@| bottom | number | 是 | - | | 安全区域右下角纵坐标，单位为px |\n@@| width | number | 是 | - | | 安全区域的宽度，单位为px |\n@@| height | number | 是 | - | | 安全区域的高度，单位为px |\n@| safeAreaInsets | **SafeAreaInsets** | 是 | - | | 在竖屏正方向下的安全区域插入位置 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| left | number | 是 | - | | 安全区域左侧插入位置，单位为px |\n@@| right | number | 是 | - | | 安全区域右侧插入位置，单位为px |\n@@| top | number | 是 | - | | 安全区顶部插入位置，单位为px |\n@@| bottom | number | 是 | - | | 安全区域底部插入位置，单位为px |\n@| ua | string | 是 | - | | 用户标识。小程序端为空 |\n@| ~~uniCompileVersion~~ | string | 是 | - | | uni 编译器版本。 **已废弃，仅为了向下兼容保留** |\n@| uniCompilerVersion | string | 是 | - | | uni 编译器版本。 |\n@| uniPlatform | \"app\" \\| \"web\" \\| \"mp-weixin\" \\| \"mp-alipay\" \\| \"mp-baidu\" \\| \"mp-toutiao\" \\| \"mp-lark\" \\| \"mp-qq\" \\| \"mp-kuaishou\" \\| \"mp-jd\" \\| \"mp-360\" \\| \"quickapp-webview\" \\| \"quickapp-webview-union\" \\| \"quickapp-webview-huawei\" | 是 | - | | uni-app 运行平台，与条件编译平台相同。
|\n@| uniRuntimeVersion | string | 是 | - | | uni 运行时版本。 |\n@| ~~uniCompileVersionCode~~ | number | 是 | - | | uni 编译器版本号。 **已废弃，仅为了向下兼容保留** |\n@| uniCompilerVersionCode | number | 是 | - | | uni 编译器版本号。 |\n@| uniRuntimeVersionCode | number | 是 | - | | uni 运行时版本号。 |\n@| ~~version~~ | string | 是 | - | | 引擎版本号。 **已废弃，仅为了向下兼容保留** |\n@| romName | string | 是 | - | | rom 名称。Android 部分机型获取不到值。iOS 恒为 `ios` |\n@| romVersion | string | 是 | - | | rom 版本号。Android 部分机型获取不到值。iOS 为操作系统版本号（同 `osVersion`）。 |\n@| windowWidth | number | 是 | - | | 可使用窗口宽度，单位为px |\n@| windowHeight | number | 是 | - | | 可使用窗口高度，单位为px |\n@| windowTop | number | 是 | - | | 内容区域距离顶部的距离（同CSS变量 `--window-top`），单位为px |\n@| windowBottom | number | 是 | - | | 内容区域距离底部的距离（同CSS变量 `--window-bottom`），单位为px |\n@| osAndroidAPILevel | number \\| null | 否 | - | | Android 系统API库的版本。
|\n@| appTheme | \"light\" \\| \"dark\" \\| \"auto\" | 否 | - | | 当前App的主题
| \n","compatibility":"### getSystemInfoSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/system/info?id=getsysteminfosync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-system-info.getSystemInfoSync)\n"},"get-system-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-system-info/get-system-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-system-info/get-system-info\n>Template\n```vue\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n type Item = {\r\n label : string,\r\n value : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'getSystemInfo',\r\n items: [] as Item[],\r\n }\r\n },\r\n onUnload: function () {\r\n },\r\n methods: {\r\n getSystemInfo: function () {\r\n uni.getSystemInfo({\r\n success: (res) => {\r\n this.items = [] as Item[];\n const res_str = JSON.stringify(res);\n const res_obj = JSON.parseObject(res_str);\n const res_map = res_obj!.toMap();\n let keys = [] as string[]\n res_map.forEach((_, key) => {\n keys.push(key);\n });\n keys.sort().forEach( key => {\n const value = res[key];\n if(value != null){\n const item = {\n \tlabel: key,\n \tvalue: \"\" + ((typeof value == \"object\")? JSON.stringify(value) : value)\n } as Item;\n this.items.push(item);\n }\n });\r\n },\r\n })\r\n },\r\n getSystemInfoSync: function () {\r\n this.items = [] as Item[];\r\n const res = uni.getSystemInfoSync()\n const res_str = JSON.stringify(res);\n const res_obj = JSON.parseObject(res_str);\n const res_map = res_obj!.toMap();\n let keys = [] as string[]\n res_map.forEach((_, key) => {\n keys.push(key);\n });\n keys.sort().forEach( key => {\n const value = res[key];\n if(value != null){\n const item = {\n \tlabel: key,\n \tvalue: \"\" + ((typeof value == \"object\")? JSON.stringify(value) : value)\n } as Item;\n this.items.push(item);\n }\n });\r\n },\r\n //自动化测试例专用\r\n jest_getSystemInfo() : GetSystemInfoResult {\r\n return uni.getSystemInfoSync();\r\n },\r\n }\r\n }\r\n\n```\n:::"},"getDeviceInfo":{"name":"## uni.getDeviceInfo(options?) @getdeviceinfo","description":"获取设备信息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **GetDeviceInfoOptions** | 否 | 包含所有字段的过滤对象 | - | \\[options=包含所有字段的过滤对象]过滤的字段对象, 不传参数默认为获取全部字段。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filter | Array\\ | 是 | - | - | 过滤字段的字符串数组，假如要获取指定字段，传入此数组。 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **GetDeviceInfoResult** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| ~~brand~~ | string | 否 | - | | 设备品牌 **已废弃，仅为了向下兼容保留** |\n@| deviceBrand | string | 否 | - | | 设备品牌 |\n@| deviceId | string | 否 | - | | 设备 id 。由 uni-app 框架生成并存储，清空 Storage 会导致改变 |\n@| ~~model~~ | string | 否 | - | | 设备型号\t **已废弃，仅为了向下兼容保留** |\n@| deviceModel | string | 否 | - | | 设备型号\t |\n@| deviceType | string | 否 | - | | 设备类型phone、pad、pc\t |\n@| deviceOrientation | string | 否 | - | | 设备方向 竖屏 portrait、横屏 landscape\t |\n@| devicePixelRatio | string | 否 | - | | 设备像素比\t |\n@| system | string | 否 | - | | 操作系统及版本\t |\n@| platform | string | 否 | - | | 客户端平台\t |\n@| isRoot | boolean | 否 | - | | 是否root |\n@| isSimulator | boolean | 否 | - | | 是否是模拟器 |\n@| isUSBDebugging | boolean | 否 | - | | adb是否开启 |\n@| osName | \"ios\" \\| \"android\" \\| \"macos\" \\| \"windows\" \\| \"linux\" | 否 | - | | 系统名称\t
|\n@| osVersion | string \\| null | 否 | - | | 操作系统版本。如 ios 版本，andriod 版本
|\n@| osLanguage | string \\| null | 否 | - | | 操作系统语言
|\n@| osTheme | \"light\" \\| \"dark\" | 否 | - | | 操作系统主题
|\n@| osAndroidAPILevel | number \\| null | 否 | - | | Android 系统API库的版本。
|\n@| romName | string \\| null | 否 | - | | rom 名称。Android 部分机型获取不到值。iOS 恒为 `ios`
|\n@| romVersion | string \\| null | 否 | - | | rom 版本号。Android 部分机型获取不到值。iOS 为操作系统版本号（同 `osVersion`）。
| \n","compatibility":"### getDeviceInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/getDeviceInfo.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-device-info)\n"},"get-device-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-device-info/get-device-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-device-info/get-device-info\n>Template\n```vue\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { setDevicePixelRatio } from '@/store/index.uts'\r\n\r\n type Item = {\r\n label : string,\r\n value : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'getDeviceInfo',\r\n items: [] as Item[],\r\n }\r\n },\r\n onUnload: function () {\r\n },\r\n methods: {\r\n getDeviceInfo: function () {\r\n const res = uni.getDeviceInfo();\r\n // 获取像素比, 供截图对比使用\r\n setDevicePixelRatio(res.devicePixelRatio !== null ? parseFloat(res.devicePixelRatio!) : 1)\r\n this.items = [] as Item[];\n\n const res_str = JSON.stringify(res);\n const res_obj = JSON.parseObject(res_str);\n const res_map = res_obj!.toMap();\n let keys = [] as string[]\n res_map.forEach((_, key) => {\n keys.push(key);\n });\n keys.sort().forEach( key => {\n const value = res[key];\n if(value != null){\n const item = {\n \tlabel: key,\n \tvalue: \"\" + ((typeof value == \"object\")? JSON.stringify(value) : value)\n } as Item;\n this.items.push(item);\n }\n });\r\n }\r\n }\r\n }\r\n\n```\n:::"},"getWindowInfo":{"name":"## uni.getWindowInfo() @getwindowinfo","description":"同步获取窗口信息","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **GetWindowInfoResult** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pixelRatio | number | 是 | - | | 设备像素比 |\n@| screenWidth | number | 是 | - | | 屏幕宽度，单位为px |\n@| screenHeight | number | 是 | - | | 屏幕高度，单位为px |\n@| windowWidth | number | 是 | - | | 可使用窗口宽度，单位为px |\n@| windowHeight | number | 是 | - | | 可使用窗口高度，单位为px |\n@| statusBarHeight | number | 是 | - | | 状态栏的高度，单位为px |\n@| windowTop | number | 是 | - | | 内容区域距离顶部的距离（同CSS变量 `--window-top`），单位为px |\n@| windowBottom | number | 是 | - | | 内容区域距离底部的距离（同CSS变量 `--window-bottom`），单位为px |\n@| safeArea | **SafeArea** | 是 | - | | 在竖屏正方向下的安全区域 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| left | number | 是 | - | | 安全区域左上角横坐标，单位为px |\n@@| right | number | 是 | - | | 安全区域右下角横坐标，单位为px |\n@@| top | number | 是 | - | | 安全区域左上角纵坐标，单位为px |\n@@| bottom | number | 是 | - | | 安全区域右下角纵坐标，单位为px |\n@@| width | number | 是 | - | | 安全区域的宽度，单位为px |\n@@| height | number | 是 | - | | 安全区域的高度，单位为px |\n@| safeAreaInsets | **SafeAreaInsets** | 是 | - | | 在竖屏正方向下的安全区域插入位置 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| left | number | 是 | - | | 安全区域左侧插入位置，单位为px |\n@@| right | number | 是 | - | | 安全区域右侧插入位置，单位为px |\n@@| top | number | 是 | - | | 安全区顶部插入位置，单位为px |\n@@| bottom | number | 是 | - | | 安全区域底部插入位置，单位为px |\n@| screenTop | number | 是 | - | | 窗口上边缘的 y 值，单位为px | \n","compatibility":"### getWindowInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/system/getWindowInfo.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-window-info)\n"},"get-window-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-window-info/get-window-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-window-info/get-window-info\n>Template\n```vue\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { setStatusBarHeight, setSafeArea } from '@/store/index.uts'\r\n // #ifdef APP-ANDROID\r\n import type { SafeArea } from '@/store/index.uts'\r\n // #endif\r\n\r\n type Item = {\r\n label : string,\r\n value : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'getWindowInfo',\r\n items: [] as Item[],\r\n }\r\n },\r\n onUnload: function () {\r\n },\r\n onReady() {\r\n this.getWindowInfo()\r\n },\r\n methods: {\r\n getWindowInfo: function () {\r\n const res = uni.getWindowInfo();\r\n // 获取状态栏高度, 供截图对比使用\r\n setStatusBarHeight(res.statusBarHeight);\r\n // 获取安全区信息,供截图使用\r\n // #ifdef APP-ANDROID\r\n setSafeArea({\r\n top: res.safeArea.top,\r\n left: res.safeArea.left,\r\n right: res.safeArea.right,\r\n bottom: res.safeArea.bottom,\r\n width: res.safeArea.width,\r\n height: res.safeArea.height,\r\n } as SafeArea);\r\n // #endif\r\n // #ifdef APP-IOS\r\n setSafeArea({\r\n top: res.safeArea.top,\r\n left: res.safeArea.left,\r\n right: res.safeArea.right,\r\n bottom: res.safeArea.bottom,\r\n width: res.safeArea.width,\r\n height: res.safeArea.height,\r\n });\r\n // #endif\r\n this.items = [] as Item[];\r\n\r\n const res_str = JSON.stringify(res);\r\n const res_obj = JSON.parseObject(res_str);\r\n const res_map = res_obj!.toMap();\r\n let keys = [] as string[]\r\n res_map.forEach((_, key) => {\r\n keys.push(key);\r\n });\r\n keys.sort().forEach(key => {\r\n const value = res[key];\r\n if (value != null) {\r\n const item = {\r\n label: key,\r\n value: \"\" + ((typeof value == \"object\") ? JSON.stringify(value) : value)\r\n } as Item;\r\n this.items.push(item);\r\n }\r\n });\r\n },\r\n //自动化测试例专用\r\n jest_getWindowInfo() : GetWindowInfoResult {\r\n return uni.getWindowInfo();\r\n },\r\n }\r\n }\r\n\n```\n:::"},"getAppBaseInfo":{"name":"## uni.getAppBaseInfo(options?) @getappbaseinfo","description":"获取app基本信息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **GetAppBaseInfoOptions** | 否 | 包含所有字段的过滤对象 | - | \\[options=包含所有字段的过滤对象] 过滤的字段对象, 不传参数默认为获取全部字段。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filter | Array\\ | 是 | - | - | 过滤字段的字符串数组，假如要获取指定字段，传入此数组。 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **GetAppBaseInfoResult** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| appId | string | 否 | - | | manifest.json 中应用appid，即DCloud appid。\t |\n@| appName | string | 否 | - | | `manifest.json` 中应用名称。 |\n@| appVersion | string | 否 | - | | `manifest.json` 中应用版本名称。 |\n@| appVersionCode | string | 否 | - | | `manifest.json` 中应用版本名号。 |\n@| appLanguage | string | 否 | - | | 应用设置的语言en、zh-Hans、zh-Hant、fr、es\t |\n@| language | string | 否 | - | | 应用设置的语言\t |\n@| ~~version~~ | string | 否 | - | | 引擎版本号。已废弃，仅为了向下兼容保留 **已废弃，仅为了向下兼容保留** |\n@| isUniAppX | boolean | 否 | - | | 是否uni-app x |\n@| ~~uniCompileVersion~~ | string | 否 | - | | uni 编译器版本 **已废弃，仅为了向下兼容保留** |\n@| uniCompilerVersion | string | 否 | - | | uni 编译器版本 |\n@| uniPlatform | \"app\" \\| \"web\" \\| \"mp-weixin\" \\| \"mp-alipay\" \\| \"mp-baidu\" \\| \"mp-toutiao\" \\| \"mp-lark\" \\| \"mp-qq\" \\| \"mp-kuaishou\" \\| \"mp-jd\" \\| \"mp-360\" \\| \"quickapp-webview\" \\| \"quickapp-webview-union\" \\| \"quickapp-webview-huawei\" | 否 | - | | uni-app 运行平台。
|\n@| uniRuntimeVersion | string | 否 | - | | uni 运行时版本 |\n@| ~~uniCompileVersionCode~~ | number | 否 | - | | uni 编译器版本号 **已废弃，仅为了向下兼容保留** |\n@| uniCompilerVersionCode | number | 否 | - | | uni 编译器版本号 |\n@| uniRuntimeVersionCode | number | 否 | - | | uni 运行时版本号 |\n@| packageName | string | 否 | - | | Android的包名 |\n@| bundleId | string | 否 | - | | iOS的bundleId |\n@| signature | string | 否 | - | | Android: 应用签名证书的SHA1值（全部为小写，中间不包含“:”）。 为了保证应用的安全性，请使用自己生成的证书（不要使用公共测试证书）。 iOS: 应用签名证书中绑定的Bundle ID（AppleID）的md5值（全部为小写）。 |\n@| appTheme | \"light\" \\| \"dark\" \\| \"auto\" | 否 | - | | 当前App的主题
| \n","compatibility":"### getAppBaseInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/getAppBaseInfo.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-app-base-info)\n"},"get-app-base-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-app-base-info/get-app-base-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-app-base-info/get-app-base-info\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\n\ttype Item = {\n\t\tlabel : string,\n\t\tvalue : string,\n\t}\n\texport default {\r\n\t\tdata() {\r\n\t\t\treturn {\r\n\t\t\t\ttitle: 'getAppBaseInfo',\n\t\t\t\titems: [] as Item[],\r\n\t\t\t}\r\n\t\t},\r\n\t\tonUnload:function(){\r\n\t\t},\r\n\t\tmethods: {\r\n\t\t\tgetAppBaseInfo: function () {\n\t\t\t\tconst res = uni.getAppBaseInfo();\n const res_str = JSON.stringify(res);\n const res_obj = JSON.parseObject(res_str);\n const res_map = res_obj!.toMap();\n let keys = [] as string[]\n res_map.forEach((_, key) => {\n keys.push(key);\n });\n\n this.items = [] as Item[];\n keys.sort().forEach( key => {\n const value = res[key];\n if(value != null){\n const item = {\n \tlabel: key,\n \tvalue: \"\" + ((typeof value == \"object\")? JSON.stringify(value) : value)\n } as Item;\n this.items.push(item);\n }\n });\n\n\t\t\t}\r\n\t\t}\r\n\t}\r\n\n```\n:::"},"getAppAuthorizeSetting":{"name":"## uni.getAppAuthorizeSetting() @getappauthorizesetting","description":"获取 APP 授权设置。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **GetAppAuthorizeSettingResult** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| albumAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" | 否 | - | | 允许 App 使用相册的开关（仅 iOS 支持）
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） |\n@| bluetoothAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 否 | - | | 允许 App 使用蓝牙的开关（仅 iOS 支持）
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
- config error: Android平台没有该值；iOS平台：表示没有在 `manifest.json -> App模块配置` 中配置 `BlueTooth(低功耗蓝牙)` 模块 |\n@| cameraAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 是 | - | | 允许 App 使用摄像头的开关
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
- config error: Android平台：表示没有配置 `android.permission.CAMERA` 权限，[权限配置详情](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#permissions)；iOS平台没有该值 |\n@| locationAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 是 | - | | 允许 App 使用定位的开关
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
- config error: Android平台：表示没有配置 `android.permission.ACCESS_COARSE_LOCATION` 权限，[权限配置详情](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#permissions)；iOS平台：表示没有在 `manifest.json -> App模块配置` 中配置 `Geolocation(定位)` 模块 |\n@| locationAccuracy | \"reduced\" \\| \"full\" \\| \"unsupported\" | 否 | - | | 定位准确度。
- reduced: 模糊定位
- full: 精准定位
- unsupported: 不支持（包括用户拒绝定位权限和没有在 `manifest.json -> App模块配置` 中配置 `Geolocation(定位)` 模块） |\n@| locationReducedAccuracy | boolean \\| null | 否 | - | | 定位准确度（推荐使用 locationAccuracy 属性）。true 表示模糊定位，false 表示精确定位（仅 iOS 支持） |\n@| microphoneAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 是 | - | | 允许 App 使用麦克风的开关
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
- config error: Android平台：表示没有配置 `android.permission.RECORD_AUDIO` 权限，[权限配置详情](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#permissions)；iOS平台没有该值 |\n@| notificationAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 是 | - | | 允许 App 通知的开关
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
- config error: Android平台没有该值；iOS平台：表示没有在 `manifest.json -> App模块配置` 中配置 `Push(推送)` 模块 |\n@| notificationAlertAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 否 | - | | 允许 App 通知带有提醒的开关（仅 iOS 支持）
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
- config error: 没有在 `manifest.json -> App模块配置` 中配置 `Push(推送)` 模块 |\n@| notificationBadgeAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 否 | - | | 允许 App 通知带有标记的开关（仅 iOS 支持）
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
- config error: 没有在 `manifest.json -> App模块配置` 中配置 `Push(推送)` 模块 |\n@| notificationSoundAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 否 | - | | 允许 App 通知带有声音的开关（仅 iOS 支持）
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
- config error: 没有在 `manifest.json -> App模块配置` 中配置 `Push(推送)` 模块 | \n","compatibility":"### getAppAuthorizeSetting 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | x |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/system/getappauthorizesetting)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-app-authorize-setting)\n"},"get-app-authorize-setting":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-app-authorize-setting/get-app-authorize-setting.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\r\n\r\n\r\n\n\n```"},"getSystemSetting":{"name":"## uni.getSystemSetting() @getsystemsetting","description":"获取系统设置","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **GetSystemSettingResult** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| bluetoothEnabled | boolean | 否 | - | | 蓝牙是否开启 |\n@| bluetoothError | string | 否 | - | | 蓝牙的报错信息 |\n@| locationEnabled | boolean | 是 | - | | 位置是否开启 |\n@| wifiEnabled | boolean | 否 | - | | wifi是否开启 |\n@| wifiError | string | 否 | - | | wifi的报错信息 |\n@| deviceOrientation | \"portrait\" \\| \"landscape\" | 是 | - | | 设备方向
| \n","compatibility":"### getSystemSetting 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/getsystemsetting.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-system-setting)\n"},"get-system-setting":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-system-setting/get-system-setting.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\r\n\r\n\r\n\n\n```"},"installApk":{"name":"## uni.installApk(options) @installapk","description":"安装apk","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [InstallApkOptions](#installapkoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | string | 是 | - | - | apk文件地址 |\n@| success | (res: [InstallApkSuccess](#installapksuccess-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (err: [InstallApkFail](#installapkfail-values)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### InstallApkSuccess 的属性值 @installapksuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | 安装成功消息 |\n\n##### InstallApkFail 的属性值 @installapkfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | 错误码 - 1300002 找不到文件 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### installApk 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.94 | x | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.install-apk)\n"},"install-apk":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/install-apk/install-apk.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\r\n\r\n\n\n```"},"getPushClientId":{"name":"## uni.getPushClientId(options) @getpushclientid","description":"获取客户端唯一的推送标识","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetPushClientIdOptions](#getpushclientidoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (result: [GetPushClientIdSuccess](#getpushclientidsuccess-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetPushClientIdSuccess 的属性值 @getpushclientidsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| cid | string | 是 | - | | 个推客户端推送id，对应uni-id-device表的push_clientid |\n| errMsg | string | 是 | - | | 错误描述 |\n","returnValue":"","compatibility":"### getPushClientId 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.98 | 4.18 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/plugins/push.html#getpushclientid)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.getPushClientId)\n"},"onPushMessage":{"name":"## uni.onPushMessage(callback) @onpushmessage","description":"启动监听推送消息事件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [OnPushMessageCallbackResult](#onpushmessagecallbackresult-values)) => void | 是 | - | - | | \n\n#### OnPushMessageCallbackResult 的属性值 @onpushmessagecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | \"click\" \\| \"receive\" | 是 | - | | 事件类型
- click 从系统推送服务点击消息启动应用事件
- receive 应用从推送服务器接收到推送消息事件 |\n| data | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | | 消息内容 |\n","returnValue":"","compatibility":"### onPushMessage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.98 | 4.18 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/plugins/push.html#onpushmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.onPushMessage)\n"},"offPushMessage":{"name":"## uni.offPushMessage(callback) @offpushmessage","description":"关闭推送消息监听事件，iOS端调用会关闭所有监听。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [OnPushMessageCallbackResult](#onpushmessagecallbackresult-values)) => void | 是 | - | - | | \n\n#### OnPushMessageCallbackResult 的属性值 @onpushmessagecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | \"click\" \\| \"receive\" | 是 | - | | 事件类型
- click 从系统推送服务点击消息启动应用事件
- receive 应用从推送服务器接收到推送消息事件 |\n| data | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | | 消息内容 |\n","returnValue":"","compatibility":"### offPushMessage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.98 | 4.18 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/plugins/push.html#offpushmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.offPushMessage)\n"},"getChannelManager":{"name":"## uni.getChannelManager() @getchannelmanager","description":"获取通知渠道管理器，Android 8系统以上才可以设置通知渠道，Android 8系统以下返回null。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [ChannelManager](#channelmanager-values) |\n\n#### ChannelManager 的方法 @channelmanager-values \n\n#### setPushChannel(options) @setpushchannel\n\n设置推送渠道\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **SetPushChannelOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| soundName | string \\| null | 否 | null | - | 添加的声音文件，注意raw目录下必须要有 ，不传此字段将使用默认铃音。 |\n@| channelId | string | 是 | - | - | 通知渠道id |\n@| channelDesc | string | 是 | - | - | 通知渠道描述 |\n@| enableLights | boolean \\| null | 否 | false | - | 呼吸灯闪烁 |\n@| enableVibration | boolean \\| null | 否 | false | - | 震动 |\n@| importance | number \\| null | 否 | 3 | - | 通知的重要性级别，可选范围IMPORTANCE_LOW：2、IMPORTANCE_DEFAULT：3、IMPORTANCE_HIGH：4 。 |\n@| lockscreenVisibility | number \\| null | 否 | -1000 | - | 锁屏可见性，可选范围VISIBILITY_PRIVATE：0、VISIBILITY_PUBLIC：1、VISIBILITY_SECRET：-1、VISIBILITY_NO_OVERRIDE：-1000。 | \n\n\n##### setPushChannel 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.98 | x | - |\n\n\n#### getAllChannels() @getallchannels\n\n获取当前应用注册的所有的通知渠道。\n\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Array\\ |\n \n\n##### getAllChannels 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.98 | x | - |\n\n \n","compatibility":"### getChannelManager 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.98 | x | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.getChannelManager)\n"},"createPushMessage":{"name":"## uni.createPushMessage(options) @createpushmessage","description":"创建本地通知栏消息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **CreatePushMessageOptions** | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| cover | boolean \\| null | 否 | false | | 是否覆盖上一次提示的消息 |\n@| delay | number \\| null | 否 | 0 | | 提示消息延迟显示的时间,单位为s |\n@| icon | string \\| null | 否 | null | | 推送消息的图标 |\n@| sound | string \\| null | 否 | \"system\" | | 推送消息的提示音
- system: 使用系统通知提示音（默认值）
- none: 不使用提示音 |\n@| title | string \\| null | 否 | App的名称 | | 推送消息的标题 |\n@| content | string | 是 | - | | 消息显示的内容，在系统通知中心中显示的文本内容 |\n@| payload | any \\| null | 否 | null | | 消息承载的数据，可根据业务逻辑自定义数据格式 |\n@| when | number \\| null | 否 | 当前时间 | | 消息上显示的提示时间 |\n@| channelId | string \\| null | 否 | \"DcloudChannelID\" | | 渠道id |\n@| category | string \\| null | 否 | null | | 通知类别 |\n@| success | (result: CreatePushMessageSuccess) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n","returnValue":"","compatibility":"### createPushMessage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.98 | 4.18 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/plugins/push.html#createpushmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.createPushMessage)\n"},"getBatteryInfo":{"name":"## uni.getBatteryInfo(options) @getbatteryinfo","description":"获取电池电量信息\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-getbatteryinfo](https://ext.dcloud.net.cn/plugin?name=uni-getbatteryinfo)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetBatteryInfoOptions](#getbatteryinfooptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (res: [GetBatteryInfoSuccess](#getbatteryinfosuccess-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |\n@| fail | (res: UniError) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void | 否 | - | - | 接口调用成功的回调 | \n\n##### GetBatteryInfoSuccess 的属性值 @getbatteryinfosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n| level | number | 是 | - | - | 设备电量，范围1 - 100 |\n| isCharging | boolean | 是 | - | - | 是否正在充电中 |\n","returnValue":"","compatibility":"### getBatteryInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-battery-info.getBatteryInfo)\n"},"getBatteryInfoSync":{"name":"## uni.getBatteryInfoSync() @getbatteryinfosync","description":"获取电池电量信息\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-getbatteryinfo](https://ext.dcloud.net.cn/plugin?name=uni-getbatteryinfo)\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **GetBatteryInfoResult** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| level | number | 是 | - | - | 设备电量，范围1 - 100 |\n@| isCharging | boolean | 是 | - | - | 是否正在充电中 | \n","compatibility":"### getBatteryInfoSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-battery-info.getBatteryInfoSync)\n"},"get-battery-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-battery-info/get-battery-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-battery-info/get-battery-info\n>Template\n```vue\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n level: 0,\n isCharging: false\n }\n },\n onLoad() {\n try {\n uni.getBatteryInfo({\n success: res => {\n this.level = res.level;\n this.isCharging = res.isCharging;\n }\n });\n } catch (e) {\n console.error(e.message);\n uni.showModal({\n content: e.message,\n showCancel: false\n });\n }\n }\n }\n\n```\n:::"},"startWifi":{"name":"## uni.startWifi(option) @startwifi","description":"\n初始化Wi-Fi模块\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| option | [WifiOption](#wifioption-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - | - |\n@| fail | (res: UniError) => void | 否 | - | - | - |\n@| complete | (res: any) => void | 否 | - | - | - | \n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | - |\n| errMsg | string | 是 | - | - | - |\n| wifi | **UniWifiInfo** \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| SSID | string | 是 | - | - | - |\n@| BSSID | string | 否 | - | - | - |\n@| secure | boolean | 否 | - | - | - |\n@| signalStrength | number | 否 | - | - | - |\n@| frequency | number | 否 | - | - | - |\n","returnValue":"","compatibility":"### startWifi 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#startwifi)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.startWifi)\n"},"stopWifi":{"name":"## uni.stopWifi(option) @stopwifi","description":"\n关闭 Wi-Fi 模块\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| option | [WifiOption](#wifioption-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - | - |\n@| fail | (res: UniError) => void | 否 | - | - | - |\n@| complete | (res: any) => void | 否 | - | - | - | \n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | - |\n| errMsg | string | 是 | - | - | - |\n| wifi | **UniWifiInfo** \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| SSID | string | 是 | - | - | - |\n@| BSSID | string | 否 | - | - | - |\n@| secure | boolean | 否 | - | - | - |\n@| signalStrength | number | 否 | - | - | - |\n@| frequency | number | 否 | - | - | - |\n","returnValue":"","compatibility":"### stopWifi 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| x | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#stopwifi)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.stopWifi)\n"},"connectWifi":{"name":"## uni.connectWifi(option) @connectwifi","description":"","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| option | [WifiConnectOption](#wificonnectoption-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| SSID | string | 否 | - | - | - |\n@| BSSID | string | 否 | - | - | - |\n@| password | string | 否 | - | - | - |\n@| maunal | boolean | 否 | - | - | - |\n@| partialInfo | boolean | 否 | - | - | - |\n@| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - | - |\n@| fail | (res: UniError) => void | 否 | - | - | - |\n@| complete | (res: any) => void | 否 | - | - | - | \n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | - |\n| errMsg | string | 是 | - | - | - |\n| wifi | **UniWifiInfo** \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| SSID | string | 是 | - | - | - |\n@| BSSID | string | 否 | - | - | - |\n@| secure | boolean | 否 | - | - | - |\n@| signalStrength | number | 否 | - | - | - |\n@| frequency | number | 否 | - | - | - |\n","returnValue":"","compatibility":"### connectWifi 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| >=4.4 && <10.0 | 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#connectWifi)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.connectWifi)\n"},"getWifiList":{"name":"## uni.getWifiList(option) @getwifilist","description":"\n请求获取 Wi-Fi 列表。wifiList 数据会在 onGetWifiList 注册的回调中返回。\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| option | [WifiOption](#wifioption-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - | - |\n@| fail | (res: UniError) => void | 否 | - | - | - |\n@| complete | (res: any) => void | 否 | - | - | - | \n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | - |\n| errMsg | string | 是 | - | - | - |\n| wifi | **UniWifiInfo** \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| SSID | string | 是 | - | - | - |\n@| BSSID | string | 否 | - | - | - |\n@| secure | boolean | 否 | - | - | - |\n@| signalStrength | number | 否 | - | - | - |\n@| frequency | number | 否 | - | - | - |\n","returnValue":"","compatibility":"### getWifiList 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#getWifiList)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.getWifiList)\n"},"onGetWifiList":{"name":"## uni.onGetWifiList(callback) @ongetwifilist","description":"\n监听获取到 Wi-Fi 列表数据事件。\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (wifiInfo: any) => void | 是 | - | - | | \n","returnValue":"","compatibility":"### onGetWifiList 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#onGetWifiList)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.onGetWifiList)\n"},"offGetWifiList":{"name":"## uni.offGetWifiList(callback) @offgetwifilist","description":"\n移除获取到 Wi-Fi 列表数据事件的监听函数。\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | | \n","returnValue":"","compatibility":"### offGetWifiList 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#offGetWifiList)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.offGetWifiList)\n"},"getConnectedWifi":{"name":"## uni.getConnectedWifi(option) @getconnectedwifi","description":"\n获取已连接的 Wi-Fi 信息\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| option | [GetConnectedWifiOptions](#getconnectedwifioptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| partialInfo | boolean | 否 | - | - | - |\n@| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - | - |\n@| fail | (res: UniError) => void | 否 | - | - | - |\n@| complete | (res: any) => void | 否 | - | - | - | \n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | - |\n| errMsg | string | 是 | - | - | - |\n| wifi | **UniWifiInfo** \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| SSID | string | 是 | - | - | - |\n@| BSSID | string | 否 | - | - | - |\n@| secure | boolean | 否 | - | - | - |\n@| signalStrength | number | 否 | - | - | - |\n@| frequency | number | 否 | - | - | - |\n","returnValue":"","compatibility":"### getConnectedWifi 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#getConnectedWifi)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.getConnectedWifi)\n"},"onWifiConnected":{"name":"## uni.onWifiConnected(callback) @onwificonnected","description":"\n监听连接上 Wi-Fi 的事件\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (wifiInfo: [UniWifiResult](#uniwifiresult-values)) => void | 是 | - | - | | \n\n#### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | - |\n| errMsg | string | 是 | - | - | - |\n| wifi | **UniWifiInfo** \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| SSID | string | 是 | - | - | - |\n@| BSSID | string | 否 | - | - | - |\n@| secure | boolean | 否 | - | - | - |\n@| signalStrength | number | 否 | - | - | - |\n@| frequency | number | 否 | - | - | - |\n","returnValue":"","compatibility":"### onWifiConnected 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#onWifiConnected)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.onWifiConnected)\n"},"onWifiConnectedWithPartialInfo":{"name":"## uni.onWifiConnectedWithPartialInfo(callback) @onwificonnectedwithpartialinfo","description":"\n监听连接上 Wi-Fi 的事件。\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (wifiInfo: [UniWifiInfoWithPartialInfo](#uniwifiinfowithpartialinfo-values)) => void | 是 | - | - | | \n\n#### UniWifiInfoWithPartialInfo 的属性值 @uniwifiinfowithpartialinfo-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| SSID | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### onWifiConnectedWithPartialInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#onWifiConnectedWithPartialInfo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.onWifiConnectedWithPartialInfo)\n"},"offWifiConnected":{"name":"## uni.offWifiConnected(callback?) @offwificonnected","description":"\n移除连接上 Wi-Fi 的事件的监听函数。\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void \\| null | 否 | - | - | | \n","returnValue":"","compatibility":"### offWifiConnected 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#offWifiConnected)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.offWifiConnected)\n"},"onMemoryWarning":{"name":"## uni.onMemoryWarning(callback) @onmemorywarning","description":"\n开启监听内存警告\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-memorywarning](https://ext.dcloud.net.cn/plugin?name=uni-memorywarning)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: [MemoryWarningCallbackResult](#memorywarningcallbackresult-values)) => void | 是 | - | - | | \n\n#### MemoryWarningCallbackResult 的属性值 @memorywarningcallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| level | number | 是 | - | - | 内存警告等级(仅安卓平台有效，iOS始终是0) |\n","returnValue":"","compatibility":"### onMemoryWarning 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/memory.html#onmemorywarning)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.memory.onMemoryWarning)\n"},"offMemoryWarning":{"name":"## uni.offMemoryWarning(callback?) @offmemorywarning","description":"\n取消监听内存不足告警事件\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-memorywarning](https://ext.dcloud.net.cn/plugin?name=uni-memorywarning)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: [MemoryWarningCallbackResult](#memorywarningcallbackresult-values)) => void \\| null | 否 | - | - | | \n\n#### MemoryWarningCallbackResult 的属性值 @memorywarningcallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| level | number | 是 | - | - | 内存警告等级(仅安卓平台有效，iOS始终是0) |\n","returnValue":"","compatibility":"### offMemoryWarning 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/memory.html#offmemorywarning)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.memory.offMemoryWarning)\n"},"onUserCaptureScreen":{"name":"## uni.onUserCaptureScreen(callback?) @onusercapturescreen","description":"\n开启截屏监听\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-usercapturescreen](https://ext.dcloud.net.cn/plugin?name=uni-usercapturescreen)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: [OnUserCaptureScreenCallbackResult](#onusercapturescreencallbackresult-values)) => void \\| null | 否 | - | - | | \n\n#### OnUserCaptureScreenCallbackResult 的属性值 @onusercapturescreencallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| path | string | 否 | - | - | 截屏文件路径（仅Android返回） |\n","returnValue":"","compatibility":"### onUserCaptureScreen 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/capture-screen.html#onusercapturescreen)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.captureScreen.onUserCaptureScreen)\n"},"offUserCaptureScreen":{"name":"## uni.offUserCaptureScreen(callback?) @offusercapturescreen","description":"\n关闭截屏监听\n\n> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-usercapturescreen](https://ext.dcloud.net.cn/plugin?name=uni-usercapturescreen)\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: [OnUserCaptureScreenCallbackResult](#onusercapturescreencallbackresult-values)) => void \\| null | 否 | - | - | | \n\n#### OnUserCaptureScreenCallbackResult 的属性值 @onusercapturescreencallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| path | string | 否 | - | - | 截屏文件路径（仅Android返回） |\n","returnValue":"","compatibility":"### offUserCaptureScreen 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/capture-screen.html#offusercapturescreen)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.captureScreen.offUserCaptureScreen)\n"},"createRequestPermissionListener":{"name":"## uni.createRequestPermissionListener() @createrequestpermissionlistener","description":"创建一个监听权限申请的对象。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [RequestPermissionListener](#requestpermissionlistener-values) |\n\n#### RequestPermissionListener 的方法 @requestpermissionlistener-values \n\n#### onRequest(callback) @onrequest\n\n监听申请系统权限\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (permissions: Array\\) => void | 是 | - | - | 申请系统权限回调，permissions为触发权限申请的所有权限 | \n\n\n##### onRequest 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### onConfirm(callback) @onconfirm\n\n监听弹出系统权限授权框\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (permissions: Array\\) => void | 是 | - | - | 弹出系统权限授权框回调，permissions为触发弹出权限授权框的所有权限 | \n\n\n##### onConfirm 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### onComplete(callback) @oncomplete\n\n监听权限申请完成\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (permissions: Array\\) => void | 是 | - | - | 权限申请完成回调，permissions为申请完成的所有权限 | \n\n\n##### onComplete 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### stop() @stop\n\n取消所有监听\n\n\n##### stop 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n","compatibility":"### createRequestPermissionListener 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.0 | - | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.createRequestPermissionListener)\n","example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/create-request-permission-listener/create-request-permission-listener.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"chooseImage":{"name":"## uni.chooseImage(options) @chooseimage","description":"从本地相册选择图片或使用相机拍照","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ChooseImageOptions](#chooseimageoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| count | number \\| null | 否 | 9 | - | 最多可以选择的图片张数，app端不限制，微信小程序最多可支持20个。 |\n@| sizeType | Array\\ \\| null | 否 | ['original','compressed'\\] | - | original 原图，compressed 压缩图，默认二者都有 |\n@| sourceType | Array\\ \\| null | 否 | ['album','camera'\\] | - | album 从相册选图，camera 使用相机，默认二者都有 |\n@| crop | **ChooseImageCropOptions** \\| null | 否 | - | - | 图像裁剪参数，设置后 sizeType 失效。 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| width | number | 是 | - | - | 裁剪的宽度，单位为px，用于计算裁剪宽高比。 |\n@@| height | number | 是 | - | - | 裁剪的高度，单位为px，用于计算裁剪宽高比。 |\n@@| quality | number \\| null | 否 | 80 | - | 取值范围为1-100，数值越小，质量越低（仅对jpg格式有效）。默认值为80。 |\n@@| resize | boolean \\| null | 否 | - | - | 是否将width和height作为裁剪保存图片真实的像素值。默认值为true。注：设置为false时在裁剪编辑界面显示图片的像素值，设置为true时不显示。 |\n@| success | (callback: [ChooseImageSuccess](#chooseimagesuccess-values)) => void \\| null | 否 | - | - | 成功则返回图片的本地文件路径列表 tempFilePaths |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### ChooseImageSuccess 的属性值 @chooseimagesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errSubject | string | 是 | - | - | 调用API的名称 |\n| errMsg | string | 是 | - | - | 描述信息 |\n| tempFilePaths | Array\\ | 是 | - | - | 图片的本地文件路径列表 |\n| tempFiles | any | 是 | - | - | 图片的本地文件列表 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### chooseImage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/image?id=chooseimage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.choose-image)\n"},"choose-image":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/choose-image/choose-image.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/choose-image/choose-image\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n var sourceTypeArray = [\n ['camera'],\n ['album'],\n ['camera', 'album']\n ]\n var sizeTypeArray = [\n ['compressed'],\n ['original'],\n ['compressed', 'original']\n ]\n export default {\n data() {\n return {\n title: 'chooseImage',\n imageList: [] as Array,\n sourceTypeIndex: 2,\n sourceType: ['拍照', '相册', '拍照或相册'],\n sizeTypeIndex: 2,\n sizeType: ['压缩', '原图', '压缩或原图'],\n countIndex: 8,\n count: [1, 2, 3, 4, 5, 6, 7, 8, 9],\n isCrop: false,\n cropPercent: 80,\n cropWidth: 100,\n cropHeight: 100,\n cropResize: false\n }\n },\n onUnload() {\n this.imageList = [];\n this.sourceTypeIndex = 2\n this.sourceType = ['拍照', '相册', '拍照或相册']\n this.sizeTypeIndex = 2\n this.sizeType = ['压缩', '原图', '压缩或原图']\n this.countIndex = 8\n },\n methods: {\n cropHeightConfim(e : InputConfirmEvent) {\n let value = parseInt(e.detail.value)\n if (value > 0) {\n this.cropHeight = value\n } else {\n uni.showToast({\n position: \"bottom\",\n title: \"裁剪高度需要大于0\"\n })\n }\n },\n cropWidthConfim(e : InputConfirmEvent) {\n let value = parseInt(e.detail.value)\n if (value > 0) {\n this.cropWidth = value\n } else {\n uni.showToast({\n position: \"bottom\",\n title: \"裁剪宽度需要大于0\"\n })\n }\n },\n cropPercentConfim(e : InputConfirmEvent) {\n let value = parseInt(e.detail.value)\n if (value > 0 && value <= 100) {\n this.cropPercent = value\n } else {\n uni.showToast({\n position: \"bottom\",\n title: \"请输入0~100之间的值\"\n })\n }\n },\n cropResizeChange(e : UniSwitchChangeEvent) {\n this.cropResize = e.detail.value\n },\n switchCrop(e : UniSwitchChangeEvent) {\n this.isCrop = e.detail.value\n },\n removeImage(index : number) {\n this.imageList.splice(index, 1)\n },\n chooseImageSource() {\n uni.showActionSheet({\n itemList: ['拍照', '相册', '拍照或相册'],\n success: (e) => {\n this.sourceTypeIndex = e.tapIndex!\n }\n })\n },\n chooseImageType() {\n uni.showActionSheet({\n itemList: ['压缩', '原图', '压缩或原图'],\n success: (e) => {\n this.sizeTypeIndex = e.tapIndex!\n }\n })\n },\n chooseImageCount(event : InputConfirmEvent) {\n let count = parseInt(event.detail.value) - 1\n if (count < 0) {\n uni.showToast({\n position: \"bottom\",\n title: \"图片数量应该大于0\"\n })\n return\n }\n this.countIndex = count\n },\n chooseImage: function () {\n // var cropOption:ChooseImageCropOptions|null = this.isCrop ? null : new ChooseImageCropOptions( )\n if (this.imageList.length >= 9) {\n uni.showToast({\n position: \"bottom\",\n title: \"已经有9张图片了，请删除部分图片之后重新选择\"\n })\n return\n }\n uni.chooseImage({\n sourceType: sourceTypeArray[this.sourceTypeIndex],\n sizeType: sizeTypeArray[this.sizeTypeIndex],\n crop: this.isCrop ? { \"quality\": this.cropPercent, \"width\": this.cropWidth, \"height\": this.cropHeight, \"resize\": this.cropResize } as ChooseImageCropOptions : null,\n count: this.imageList.length + this.count[this.countIndex] > 9 ? 9 - this.imageList.length : this.count[this.countIndex],\n success: (res) => {\n this.imageList = this.imageList.concat(res.tempFilePaths);\n },\n fail: (err) => {\n console.log(\"err: \", JSON.stringify(err));\n }\n })\n },\n previewImage: function (index : number) {\n uni.previewImage({\n current: index,\n urls: this.imageList\n })\n }\n }\n }\n\n```\n:::"},"previewImage":{"name":"## uni.previewImage(options) @previewimage","description":"预览图片","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [PreviewImageOptions](#previewimageoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| current | any \\| null | 否 | - | - | current 为当前显示图片的链接/索引值，不填或填写的值无效则为 urls 的第一张。 |\n@| urls | Array\\<[string.ImageURIString](/uts/data-type.md#ide-string)\\> | 是 | - | - | 需要预览的图片链接列表 |\n@| indicator | string \\| null | 否 | - | - | 图片指示器样式
- default: 底部圆点指示器
- number: 顶部数字指示器
- none: 不显示指示器 |\n@| loop | boolean \\| null | 否 | - | - | 是否可循环预览 |\n@| success | (callback: [PreviewImageSuccess](#previewimagesuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### PreviewImageSuccess 的属性值 @previewimagesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errSubject | string | 是 | - | - | 调用API的名称 |\n| errMsg | string | 是 | - | - | 描述信息 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### previewImage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/image?id=previewimage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.preview-image.previewImage)\n"},"closePreviewImage":{"name":"## uni.closePreviewImage(options) @closepreviewimage","description":"关闭图片预览","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ClosePreviewImageOptions](#closepreviewimageoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (callback: [ClosePreviewImageSuccess](#closepreviewimagesuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### ClosePreviewImageSuccess 的属性值 @closepreviewimagesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | 错误信息 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### closePreviewImage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/image?id=closepreviewimage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.preview-image.closePreviewImage)\n"},"preview-image":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/preview-image/preview-image.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/preview-image/preview-image\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n type ItemType = {\n value : string,\n name : string\n }\n\n export default {\n data() {\n return {\n imageList: [\"https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni@2x.png\", \"/static/uni.png\"],\n indicator: [{\n value: \"default\",\n name: \"圆点\"\n }, {\n value: \"number\",\n name: \"数字\"\n }, {\n value: \"none\",\n name: \"不显示\"\n }] as ItemType[],\n currentIndicator: \"default\",\n isLoop: true\n }\n },\n methods: {\n previewImage(index : number) {\n uni.previewImage({\n urls: this.imageList,\n current: index,\n indicator: this.currentIndicator,\n loop: this.isLoop\n })\n },\n chooseImage() {\n uni.chooseImage({\n sourceType: ['album'],\n success: (e) => {\n this.imageList = this.imageList.concat(e.tempFilePaths)\n },\n fail(_) {\n }\n })\n },\n onIndicatorChanged(e : UniRadioGroupChangeEvent) {\n this.currentIndicator = e.detail.value\n },\n onCheckboxChange(_ : UniCheckboxGroupChangeEvent) {\n this.isLoop = !this.isLoop\n }\n }\n }\n\n```\n:::"},"saveImageToPhotosAlbum":{"name":"## uni.saveImageToPhotosAlbum(options) @saveimagetophotosalbum","description":"保存图片到系统相册","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SaveImageToPhotosAlbumOptions](#saveimagetophotosalbumoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.ImageURIString](/uts/data-type.md#ide-string) | 是 | - | - | 图片文件路径，可以是临时文件路径也可以是永久文件路径，不支持网络图片路径 |\n@| success | (callback: [SaveImageToPhotosAlbumSuccess](#saveimagetophotosalbumsuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SaveImageToPhotosAlbumSuccess 的属性值 @saveimagetophotosalbumsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| path | string | 是 | - | - | 保存到相册的图片路径 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### saveImageToPhotosAlbum 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/image?id=saveimagetophotosalbum)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.save-image-to-photos-album)\n"},"save-image-to-photos-album":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/save-image-to-photos-album/save-image-to-photos-album.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"getImageInfo":{"name":"## uni.getImageInfo(options) @getimageinfo","description":"获取图片信息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetImageInfoOptions](#getimageinfooptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| src | [string.ImageURIString](/uts/data-type.md#ide-string) | 是 | - | - | 图片的路径，可以是相对路径，临时文件路径，存储文件路径，网络图片路径 |\n@| success | (callback: [GetImageInfoSuccess](#getimageinfosuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetImageInfoSuccess 的属性值 @getimageinfosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| width | number | 是 | - | - | 图片宽度，单位px |\n| height | number | 是 | - | - | 图片高度，单位px |\n| path | string | 是 | - | - | 返回图片的本地路径 |\n| orientation | string \\| null | 否 | - | - | 返回图片的方向 |\n| type | string \\| null | 否 | - | - | 返回图片的格式 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### getImageInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | - | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/image?id=getimageinfo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.get-image-info)\n"},"get-image-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-image-info/get-image-info.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"compressImage":{"name":"## uni.compressImage(options) @compressimage","description":"压缩图片","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [CompressImageOptions](#compressimageoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| src | [string.ImageURIString](/uts/data-type.md#ide-string) | 是 | - | - | 图片路径，图片的路径，可以是相对路径、临时文件路径、存储文件路径 |\n@| quality | number \\| null | 否 | - | - | 压缩质量，范围0～100，数值越小，质量越低，压缩率越高（仅对jpg有效） |\n@| rotate | number \\| null | 否 | - | - | 旋转度数，范围0～360 |\n@| width | string \\| null | 否 | - | - | 缩放图片的宽度 |\n@| height | string \\| null | 否 | - | - | 缩放图片的高度 |\n@| compressedHeight | number \\| null | 否 | - | - | 压缩后图片的高度，单位为px，若不填写则默认以compressedWidth为准等比缩放 |\n@| compressedWidth | number \\| null | 否 | - | - | 压缩后图片的宽度，单位为px，若不填写则默认以compressedHeight为准等比缩放。 |\n@| success | (callback: [CompressImageSuccess](#compressimagesuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### CompressImageSuccess 的属性值 @compressimagesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tempFilePath | string | 是 | - | - | 压缩后图片的临时文件路径 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### compressImage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | - | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/image?id=compressimage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.compress-image)\n"},"compress-image":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/compress-image/compress-image.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"chooseVideo":{"name":"## uni.chooseVideo(options) @choosevideo","description":"拍摄视频或从手机相册中选视频，返回视频的临时文件路径。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ChooseVideoOptions](#choosevideooptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| sourceType | Array\\ \\| null | 否 | - | - | album 从相册选视频，camera 使用相机拍摄，默认为：['album', 'camera'\\] |\n@| compressed | boolean \\| null | 否 | true | - | 是否压缩所选的视频源文件，默认值为true，需要压缩 |\n@| maxDuration | number \\| null | 否 | - | - | 拍摄视频最长拍摄时间，单位秒。最长支持 60 秒 |\n@| camera | string \\| null | 否 | - | - | 摄像切换
- front: 前置摄像头
- back: 后置摄像头 |\n@| success | (callback: [ChooseVideoSuccess](#choosevideosuccess-values)) => void \\| null | 否 | - | - | 接口调用成功，返回视频文件的临时文件路径，详见返回参数说明 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### ChooseVideoSuccess 的属性值 @choosevideosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tempFilePath | string | 是 | - | - | 选定视频的临时文件路径 |\n| duration | number | 是 | - | - | 选定视频的时间长度 |\n| size | number | 是 | - | - | 选定视频的数据量大小 |\n| height | number | 是 | - | - | 返回选定视频的长 |\n| width | number | 是 | - | - | 返回选定视频的宽 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### chooseVideo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | 4.18 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/video?id=choosevideo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.choose-video)\n"},"choose-video":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/choose-video/choose-video.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/choose-video/choose-video\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n import { ItemType } from '@/components/enum-data/enum-data';\n export default {\n data() {\n return {\n title: \"chooseVideo\",\n src: \"\",\n sourceTypeItemTypes: [{ \"value\": 0, \"name\": \"从相册中选择视频\" }, { \"value\": 1, \"name\": \"拍摄视频\" }, { \"value\": 2, \"name\": \"从相册中选择视频或拍摄视频\" }] as ItemType[],\n sourceTypeItems: [[\"album\"], [\"camera\"], [\"album\", \"camera\"]],\n cameraItemTypes: [{ \"value\": 0, \"name\": \"后置摄像头\" }, { \"value\": 1, \"name\": \"前置摄像头\" }] as ItemType[],\n cameraItems: [\"back\", \"front\"],\n sourceType: [\"album\", \"camera\"],\n compressed: true,\n maxDuration: 60,\n camera: \"back\",\n videoInfo: \"\"\n }\n },\n methods: {\n chooseVideo() {\n uni.chooseVideo({\n sourceType: this.sourceType,\n // #ifdef APP\n compressed: this.compressed,\n // #endif\n maxDuration: this.maxDuration,\n camera: this.camera,\n success: (res) => {\n console.log(\"chooseVideo success\", JSON.stringify(res));\n this.src = res.tempFilePath;\n this.videoInfo = `视频长度: ${res.duration}s\\n视频大小: ${Math.ceil(res.size / 1024)}KB\\n视频宽度: ${res.width}\\n视频高度: ${res.height}\\n`;\n },\n fail: (err) => {\n uni.showModal({\n title: \"选择视频失败\",\n content: JSON.stringify(err),\n showCancel: false\n });\n }\n });\n },\n onSourceTypeChange(value : number) {\n this.sourceType = this.sourceTypeItems[value];\n },\n onCompressedChange(value : boolean) {\n this.compressed = value;\n },\n onMaxDurationConfirm(value : number) {\n this.maxDuration = value;\n },\n onCameraChange(value : number) {\n this.camera = this.cameraItems[value];\n }\n }\n }\n\n```\n:::"},"saveVideoToPhotosAlbum":{"name":"## uni.saveVideoToPhotosAlbum(options) @savevideotophotosalbum","description":"保存视频到系统相册","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SaveVideoToPhotosAlbumOptions](#savevideotophotosalbumoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.VideoURIString](/uts/data-type.md#ide-string) | 是 | - | - | 视频文件路径，可以是临时文件路径也可以是永久文件路径 |\n@| success | (callback: SaveVideoToPhotosAlbumSuccess) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### saveVideoToPhotosAlbum 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | 4.18 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/video?id=savevideotophotosalbum)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.save-video-to-photos-album)\n"},"save-video-to-photos-album":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/save-video-to-photos-album/save-video-to-photos-album.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"getVideoInfo":{"name":"## uni.getVideoInfo(options) @getvideoinfo","description":"获取视频详细信息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetVideoInfoOptions](#getvideoinfooptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| src | [string.VideoURIString](/uts/data-type.md#ide-string) | 是 | - | - | 视频文件路径，可以是临时文件路径也可以是永久文件路径 |\n@| success | (callback: [GetVideoInfoSuccess](#getvideoinfosuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetVideoInfoSuccess 的属性值 @getvideoinfosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| orientation | string \\| null | 否 | - | - | 画面方向 |\n| type | string \\| null | 否 | - | - | 视频格式 |\n| duration | number | 是 | - | - | 视频长度 |\n| size | number | 是 | - | - | 视频大小，单位 kB |\n| height | number | 是 | - | - | 视频的长，单位 px |\n| width | number | 是 | - | - | 视频的宽，单位 px |\n| fps | number \\| null | 否 | - | - | 视频帧率 |\n| bitrate | number \\| null | 否 | - | - | 视频码率，单位 kbps |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### getVideoInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | - | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/video?id=getvideoinfo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.get-video-info)\n"},"get-video-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-video-info/get-video-info.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"compressVideo":{"name":"## uni.compressVideo(options) @compressvideo","description":"压缩视频","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [CompressVideoOptions](#compressvideooptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| src | [string.VideoURIString](/uts/data-type.md#ide-string) | 是 | - | - | 视频文件路径，可以是临时文件路径也可以是永久文件路径 |\n@| quality | string \\| null | 否 | - | - | 压缩质量
- low: 低
- medium: 中
- high: 高 |\n@| resolution | number \\| null | 否 | - | - | 相对于原视频的分辨率比例，取值范围(0, 1\\] |\n@| success | (callback: [CompressVideoSuccess](#compressvideosuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### CompressVideoSuccess 的属性值 @compressvideosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tempFilePath | string | 是 | - | - | 压缩后的临时文件地址 |\n| size | number | 是 | - | - | 压缩后的大小，单位 kB |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### compressVideo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | - | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/video?id=compressvideo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.compress-video)\n"},"compress-video":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/compress-video/compress-video.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"getLocation":{"name":"## uni.getLocation(options) @getlocation","description":"获取当前的地理位置、速度","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetLocationOptions](#getlocationoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| type | \"wgs84\" \\| \"gcj02\" | 否 | wgs84 | - | 默认为 wgs84 返回 gps 坐标，gcj02 返回可用于uni.openLocation的坐标，web端需配置定位 SDK 信息才可支持 gcj02 |\n@| altitude | boolean \\| null | 否 | false | - | 传入 true 会返回高度信息，由于获取高度需要较高精确度，会减慢接口返回速度 |\n@| geocode | boolean \\| null | 否 | false | - | 传入 true 会解析地址 |\n@| highAccuracyExpireTime | number \\| null | 否 | 3000 | - | 高精度定位超时时间(ms)，指定时间内返回最高精度，该值3000ms以上高精度定位才有效果 |\n@| isHighAccuracy | boolean \\| null | 否 | false | - | 开启高精度定位 |\n@| success | (result: [GetLocationSuccess](#getlocationsuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [IGetLocationFail](#igetlocationfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetLocationSuccess 的属性值 @getlocationsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| latitude | number | 是 | 0 | - | 纬度，浮点数，范围为-90~90，负数表示南纬 |\n| longitude | number | 是 | 0 | - | 经度，范围为-180~180，负数表示西经 |\n| speed | number | 是 | 0 | - | 速度，浮点数，单位m/s |\n| accuracy | number | 是 | - | - | 位置的精确度 |\n| altitude | number | 是 | 0 | - | 高度，单位 m |\n| verticalAccuracy | number | 是 | 0 | - | 垂直精度，单位 m（Android 无法获取，返回 0） |\n| horizontalAccuracy | number | 是 | 0 | - | 水平精度，单位 m |\n| address | any \\| null | 否 | null | - | 地址信息 |\n\n##### IGetLocationFail 的属性值 @igetlocationfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1505004 \\| 1505005 \\| 1505021 \\| 1505022 \\| 1505023 \\| 1505024 \\| 1505025 \\| 1505026 | 是 | - | - | 错误码
- 1505004 缺失权限
- 1505005 缺失高精度权限授权（iOS特有）
- 1505021 超时
- 1505022 不支持的定位类型
- 1505023 不支持逆地理编码
- 1505024 没有找到具体的定位引擎，请定位开关是否已打开
- 1505025 逆地理编码捕获失败
- 1505026 捕获定位失败 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### getLocation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/location/location?id=getlocation)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.location.get-location)\n"},"get-location":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-location/get-location.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-location/get-location\n>Template\n```vue\n\n\n\n```\n>Script\n```uts\n\n type ItemType = {\n value : 'wgs84' | 'gcj02',\n name : string,\n }\n export default {\n data() {\n return {\n title: 'get-location',\n altitudeSelect: false,\n isHighAccuracySelect: false,\n geocodeSelect: false,\n exeRet: '',\n items: [\n {\n value: 'wgs84',\n name: 'wgs84'\n },\n {\n value: 'gcj02',\n name: 'gcj02'\n }\n ] as ItemType[],\n current: 0,\n }\n },\n methods: {\n altitudeChange: function (e : UniSwitchChangeEvent) {\n this.altitudeSelect = e.detail.value\n },\n geocodeChange: function (e : UniSwitchChangeEvent) {\n this.geocodeSelect = e.detail.value\n },\n highAccuracySelectChange: function (e : UniSwitchChangeEvent) {\n this.isHighAccuracySelect = e.detail.value\n },\n radioChange(e : UniRadioGroupChangeEvent) {\n for (let i = 0; i < this.items.length; i++) {\n if (this.items[i].value === e.detail.value) {\n this.current = i;\n break;\n }\n }\n },\n getLocationTap: function () {\n uni.showLoading({\n title: '定位中'\n })\n uni.getLocation(({\n type: this.items[this.current].value,\n altitude: this.altitudeSelect,\n isHighAccuracy: this.isHighAccuracySelect,\n geocode: this.geocodeSelect,\n success: (res : any) => {\n uni.hideLoading()\n console.log(res);\n this.exeRet = JSON.stringify(res)\n },\n fail: (res : any) => {\n uni.hideLoading()\n console.log(res);\n this.exeRet = JSON.stringify(res)\n },\n complete: (res : any) => {\n uni.hideLoading()\n console.log(res);\n this.exeRet = JSON.stringify(res)\n }\n }));\n\n\n }\n\n }\n }\n\n```\n:::"},"getStorageInfo":{"name":"## uni.getStorageInfo(options) @getstorageinfo","description":"\nuni.getStorageInfo函数定义\n异步获取当前 storage 的相关信息。\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetStorageInfoOptions](#getstorageinfooptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (res: [GetStorageInfoSuccess](#getstorageinfosuccess-values)) => void \\| null | 否 | - | - | uni.getStorageInfo成功回调函数定义 |\n@| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | - | - | uni.getStorageInfo失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.getStorageInfo完成回调函数定义 | \n\n##### GetStorageInfoSuccess 的属性值 @getstorageinfosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| keys | Array\\ | 是 | - | - | 当前 storage 中所有的 key |\n| currentSize | number | 是 | - | - | 当前占用的空间大小, 单位：kb |\n| limitSize | number | 是 | - | - | 限制的空间大小, 单位：kb |\n","returnValue":"","compatibility":"### getStorageInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorageinfo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.getStorageInfo)\n"},"getStorageInfoSync":{"name":"## uni.getStorageInfoSync() @getstorageinfosync","description":"\nuni.getStorageInfoSync函数定义\n同步获取当前 storage 的相关信息。\n\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **GetStorageInfoSuccess** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| keys | Array\\ | 是 | - | - | 当前 storage 中所有的 key |\n@| currentSize | number | 是 | - | - | 当前占用的空间大小, 单位：kb |\n@| limitSize | number | 是 | - | - | 限制的空间大小, 单位：kb | \n","compatibility":"### getStorageInfoSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorageinfosync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.getStorageInfoSync)\n"},"getStorage":{"name":"## uni.getStorage(options) @getstorage","description":"\nuni.getStorage函数定义\n从本地存储中异步获取指定 key 对应的内容。\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetStorageOptions](#getstorageoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| key | string | 是 | - | - | 本地存储中的指定的 key |\n@| success | (res: [GetStorageSuccess](#getstoragesuccess-values)) => void \\| null | 否 | - | - | uni.getStorage成功回调函数定义 |\n@| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | - | - | uni.getStorage失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.getStorage完成回调函数定义 | \n\n##### GetStorageSuccess 的属性值 @getstoragesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | any \\| null | 否 | - | - | key 对应的内容 |\n","returnValue":"","compatibility":"### getStorage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.getStorage)\n"},"getStorageSync":{"name":"## uni.getStorageSync(key) @getstoragesync","description":"\nuni.getStorageSync函数定义\n从本地存储中同步获取指定 key 对应的内容。\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 本地存储中的指定的 key | \n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| any \\| null | 否 |\n \n","compatibility":"### getStorageSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstoragesync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.getStorageSync)\n"},"setStorage":{"name":"## uni.setStorage(options) @setstorage","description":"\nuni.setStorage函数定义\n将数据存储在本地storage存储中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个异步接口。 \n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **SetStorageOptions** | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| key | string | 是 | - | - | 本地存储中的指定的 key |\n@| data | any | 是 | - | - | 需要存储的内容，只支持能通过 JSON.stringify 序列化的对象 |\n@| success | (res: SetStorageSuccess) => void \\| null | 否 | - | - | uni.setStorage成功回调函数定义 |\n@| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | - | - | uni.setStorage失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.setStorage完成回调函数定义 | \n","returnValue":"","compatibility":"### setStorage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#setstorage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.setStorage)\n"},"setStorageSync":{"name":"## uni.setStorageSync(key, data) @setstoragesync","description":"\nuni.setStorageSync函数定义\n将 data 存储在本地storage存储中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个同步接口。\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 本地storage存储中的指定的 key |\n| data | any | 是 | - | - | 需要存储的内容，只支持能通过 JSON.stringify 序列化的对象 | \n","returnValue":"","compatibility":"### setStorageSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#setstoragesync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.setStorageSync)\n"},"removeStorage":{"name":"## uni.removeStorage(options) @removestorage","description":"\nuni.removeStorage函数定义\n从本地存储中异步移除指定 key。\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **RemoveStorageOptions** | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| key | string | 是 | - | - | 本地存储中的指定的 key |\n@| success | (res: RemoveStorageSuccess) => void \\| null | 否 | - | - | uni.removeStorage成功回调函数定义 |\n@| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | - | - | uni.removeStorage失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.removeStorage完成回调函数定义 | \n","returnValue":"","compatibility":"### removeStorage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](hhttps://uniapp.dcloud.net.cn/api/storage/storage.html#removestorage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.removeStorage)\n"},"removeStorageSync":{"name":"## uni.removeStorageSync(key) @removestoragesync","description":"\nuni.removeStorageSync函数定义\n从本地存储中同步移除指定 key。\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 本地存储中的指定的 key | \n","returnValue":"","compatibility":"### removeStorageSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#removestoragesync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.removeStorageSync)\n"},"clearStorage":{"name":"## uni.clearStorage(option?) @clearstorage","description":"\nuni.clearStorage函数定义\n清除本地数据存储。\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| option | **ClearStorageOptions** \\| null | 否 | - | - | uni.removeStorage参数定义 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (res: ClearStorageSuccess) => void \\| null | 否 | - | - | uni.clearStorage 成功回调函数定义 |\n@| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | - | - | uni.clearStorage 失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.clearStorage 完成回调函数定义 | \n","returnValue":"","compatibility":"### clearStorage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#clearstorage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.clearStorage)\n"},"clearStorageSync":{"name":"## uni.clearStorageSync() @clearstoragesync","description":"\nuni.clearStorageSync函数定义\n清除本地数据存储。\n","param":"","returnValue":"","compatibility":"### clearStorageSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#clearstoragesync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.clearStorageSync)\n"},"storage":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/storage/storage.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/storage/storage\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: 'get/set/clearStorage',\n key: '',\n data: '' as any,\n apiGetData: '' as any | null,\n storageInfo: '',\n }\n },\n methods: {\n getStorageInfo() {\n uni.getStorageInfo({\n success: (res) => {\n this.apiGetData = res\n this.storageInfo = JSON.stringify(res)\n },\n })\n },\n getStorageInfoSync() {\n try {\n const res = uni.getStorageInfoSync()\n this.apiGetData = res\n this.storageInfo = JSON.stringify(res)\n } catch (e) {\n // error\n console.log(e)\n }\n },\n jsonLikeMock() {\n this.key = 'key_' + Math.random()\n this.data = JSON.stringify({\n name: \"james\",\n age: 12,\n from: \"american\"\n });\n\n },\n longLikeMock() {\n this.key = 'key_' + Math.random()\n this.data = \"1234567890\"\n },\n floatLikeMock() {\n this.key = 'key_' + Math.random()\n this.data = \"321456.1234567890\"\n },\n negativeLikeMock() {\n this.key = 'key_' + Math.random()\n this.data = \"-321456\"\n },\n strMock() {\n this.key = 'key_' + Math.random()\n this.data = '测试字符串数据，长度为16个字符'\n },\n complexMock() {\n this.key = 'key_' + Math.random()\n let jsonObj = {\n name: '张三',\n age: 12,\n classMate: [\n {\n id: 1001,\n name: '李四',\n },\n {\n id: 1002,\n name: 'jack ma',\n },\n ],\n }\n this.data = jsonObj\n },\n numberMock() {\n this.key = 'key_' + Math.random()\n this.data = 10011\n },\n floatMock() {\n this.key = 'key_' + Math.random()\n this.data = 3.1415926535893384626\n },\n\n keyChange: function (e : InputEvent) {\n this.key = e.detail.value\n },\n dataChange: function (e : InputEvent) {\n this.data = e.detail.value\n },\n getStorage: function () {\n var key = this.key\n if (key.length == 0) {\n uni.showModal({\n title: '读取数据失败',\n content: 'key 不能为空',\n showCancel: false,\n })\n } else {\n let that = this\n uni.getStorage({\n key: key,\n success: (res) => {\n\n that.apiGetData = res.data\n let desc : string = typeof this.apiGetData\n if (\"object\" == desc) {\n desc = desc + \": \" + JSON.stringify(this.apiGetData)\n } else {\n desc = desc + \": \" + this.apiGetData\n }\n\n uni.showModal({\n title: '读取数据成功',\n content: desc,\n showCancel: false,\n })\n },\n fail: () => {\n uni.showModal({\n title: '读取数据失败',\n content: '找不到 key 对应的数据',\n showCancel: false,\n })\n },\n })\n }\n },\n getStorageSync: function () {\n var key = this.key\n if (key.length == 0) {\n uni.showModal({\n title: '读取数据失败',\n content: 'key 不能为空',\n showCancel: false,\n })\n } else {\n this.apiGetData = uni.getStorageSync(key)\n\n let desc : string = typeof this.apiGetData\n if (\"object\" == desc) {\n desc = desc + \": \" + JSON.stringify(this.apiGetData)\n } else {\n desc = desc + \": \" + this.apiGetData\n }\n\n uni.showModal({\n title: '读取数据成功',\n content: desc,\n showCancel: false,\n })\n }\n },\n setStorage: function () {\n var key = this.key\n var data = this.data\n if (key.length == 0) {\n uni.showModal({\n title: '保存数据失败',\n content: 'key 不能为空',\n showCancel: false,\n })\n } else {\n uni.setStorage({\n key: key,\n data: data,\n success: () => {\n uni.showModal({\n title: '存储数据成功',\n showCancel: false,\n })\n },\n fail: () => {\n uni.showModal({\n title: '储存数据失败!',\n showCancel: false,\n })\n },\n })\n }\n },\n setStorageSync: function () {\n var key = this.key\n var data = this.data\n if (key.length == 0) {\n uni.showModal({\n title: '保存数据失败',\n content: 'key 不能为空',\n showCancel: false,\n })\n } else {\n uni.setStorageSync(key, data)\n uni.showModal({\n title: '存储数据成功',\n showCancel: false,\n })\n }\n },\n removeStorage: function () {\n uni.removeStorage({\n key: this.key,\n success: () => {\n uni.showModal({\n title: '移除数据成功',\n showCancel: false,\n })\n },\n fail: () => {\n uni.showModal({\n title: '移除数据失败',\n showCancel: false,\n })\n },\n })\n },\n removeStorageSync: function () {\n uni.removeStorageSync(this.key)\n uni.showModal({\n title: '移除数据成功',\n showCancel: false,\n })\n },\n clearStorage: function () {\n this.key = ''\n this.data = ''\n uni.clearStorage({\n success: function (_) {\n uni.showModal({\n title: '清除数据成功',\n showCancel: false,\n })\n },\n fail: function (_) {\n uni.showModal({\n title: '清除数据失败',\n showCancel: false,\n })\n },\n })\n },\n clearStorageSync: function () {\n this.key = ''\n this.data = ''\n uni.clearStorageSync()\n uni.showModal({\n title: '清除数据成功',\n content: ' ',\n showCancel: false,\n })\n },\n },\n }\n\n```\n:::"},"getFileSystemManager":{"name":"## uni.getFileSystemManager() @getfilesystemmanager","description":"\n获取文件管理器","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [FileSystemManager](#filesystemmanager-values) |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| close | any | 是 | - | | 关闭文件 |\n#### FileSystemManager 的方法 @filesystemmanager-values \n\n#### readFile(options) @readfile\n\n读取本地文件内容\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ReadFileOptions](#readfileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| encoding | \"base64\" \\| \"utf-8\" | 是 | - | - | base64 / utf-8 |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 文件路径，支持相对地址和绝对地址，app-android平台支持代码包文件目录 |\n@| success | (res: [ReadFileSuccessResult](#readfilesuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 通用的错误返回结果回调 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 通用的结束返回结果回调 | \n\n##### ReadFileSuccessResult 的属性值 @readfilesuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | string | 是 | - | - | - |\n\n##### IFileSystemManagerFail 的属性值 @ifilesystemmanagerfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1200002 \\| 1300002 \\| 1300013 \\| 1300021 \\| 1300022 \\| 1300066 \\| 1301003 \\| 1301005 \\| 1300201 \\| 1300202 \\| 1301111 \\| 1302003 \\| 1300009 | 是 | - | - | 错误码
- 1200002 类型错误。仅支持 base64 / utf-8
- 1300002 未找到文件
- 1300013 无权限
- 1300021 是目录
- 1300022 参数无效
- 1300066 目录非空
- 1301003 对目录的非法操作
- 1301005 文件已存在
- 1300201 系统错误
- 1300202 超出文件存储限制的最大尺寸
- 1301111 brotli解压失败
- 1302003 标志无效
- 1300009 文件描述符错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n\n##### readFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### readFileSync(filePath, encoding?) @readfilesync\n\nFileSystemManager.readFile 的同步版本参数\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filePath | string | 是 | - | - | 文件路径，支持相对地址和绝对地址，app-android平台支持代码包文件目录 |\n| encoding | string \\| null | 否 | - | - | base64 / utf-8 | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| string |\n \n\n##### readFileSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### writeFile(options) @writefile\n\n写文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [WriteFileOptions](#writefileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 文件路径，只支持绝对地址 |\n@| encoding | \"ascii\" \\| \"base64\" \\| \"utf-8\" | 是 | - | - | 指定写入文件的字符编码
支持:ascii base64 utf-8 |\n@| data | string | 是 | - | - | 写入的文本内容 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 通用的正确返回结果回调 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### FileManagerSuccessResult 的属性值 @filemanagersuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n\n\n##### writeFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### writeFileSync(filePath, data, encoding) @writefilesync\n\nFileSystemManager.writeFile 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filePath | string | 是 | - | - | 文件路径，只支持绝对地址 |\n| data | string | 是 | - | - | 写入的文本内容 |\n| encoding | string | 是 | - | - | 指定写入文件的字符编码,支持:ascii base64 utf-8 | \n\n\n##### writeFileSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### unlink(options) @unlink\n\n删除文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UnLinkOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 文件路径，只支持绝对地址 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### unlink 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### unlinkSync(filePath) @unlinksync\n\nFileSystemManager.unlink 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filePath | string | 是 | - | - | 文件路径，只支持绝对地址 | \n\n\n##### unlinkSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### mkdir(options) @mkdir\n\n创建目录\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MkDirOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| dirPath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 创建的目录路径 (本地路径) |\n@| recursive | boolean | 是 | - | - | 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在，则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true，将创建 a 目录，再在 a 目录下创建 b 目录，以此类推直至创建 a/b/c 目录下的 d 目录。 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### mkdir 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### mkdirSync(dirPath, recursive) @mkdirsync\n\nFileSystemManager.mkdir 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| dirPath | string | 是 | - | - | 创建的目录路径 (本地路径) |\n| recursive | boolean | 是 | - | - | 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在，则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true，将创建 a 目录，再在 a 目录下创建 b 目录，以此类推直至创建 a/b/c 目录下的 d 目录。 | \n\n\n##### mkdirSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### rmdir(options) @rmdir\n\n删除目录\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **RmDirOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| dirPath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要删除的目录路径 (本地路径) |\n@| recursive | boolean | 是 | - | - | 是否递归删除目录。如果为 true，则删除该目录和该目录下的所有子目录以及文件。 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### rmdir 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### rmdirSync(dirPath, recursive) @rmdirsync\n\nFileSystemManager.rmdir 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| dirPath | string | 是 | - | - | 要删除的目录路径 (本地路径) |\n| recursive | boolean | 是 | - | - | 是否递归删除目录。如果为 true，则删除该目录和该目录下的所有子目录以及文件。 | \n\n\n##### rmdirSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### readdir(options) @readdir\n\n读取目录内文件列表\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ReadDirOptions](#readdiroptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| dirPath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要读取的目录路径 (本地路径) |\n@| success | (res: [ReadDirSuccessResult](#readdirsuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### ReadDirSuccessResult 的属性值 @readdirsuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| files | Array\\ | 是 | - | - | - |\n\n\n##### readdir 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### readdirSync(dirPath) @readdirsync\n\nFileSystemManager.readdir 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| dirPath | string | 是 | - | - | 要读取的目录路径 (本地路径) | \n\n##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Array\\ \\| null | 否 |\n \n\n##### readdirSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### access(options) @access\n\n判断文件/目录是否存在\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **AccessOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| path | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要删除的目录路径 (本地路径) |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### access 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### accessSync(path) @accesssync\n\nFileSystemManager.access 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| path | string | 是 | - | - | 要删除的目录路径 (本地路径) | \n\n\n##### accessSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### rename(options) @rename\n\n重命名文件。可以把文件从 oldPath 移动到 newPath\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **RenameOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| oldPath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 源文件路径，支持本地路径 |\n@| newPath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 新文件路径，支持本地路径 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### rename 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### renameSync(oldPath, newPath) @renamesync\n\nFileSystemManager.rename 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| oldPath | string | 是 | - | - | 源文件路径，支持本地路径 |\n| newPath | string | 是 | - | - | 新文件路径，支持本地路径 | \n\n\n##### renameSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### copyFile(options) @copyfile\n\n复制文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **CopyFileOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| srcPath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 源文件路径，支持本地路径 |\n@| destPath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 新文件路径，支持本地路径 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### copyFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### copyFileSync(srcPath, destPath) @copyfilesync\n\nFileSystemManager.copyFile 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| srcPath | string | 是 | - | - | 源文件路径，支持本地路径 |\n| destPath | string | 是 | - | - | 新文件路径，支持本地路径 | \n\n\n##### copyFileSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### getFileInfo(options) @getfileinfo\n\n获取该本地临时文件 或 本地缓存文件 信息\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetFileInfoOptions](#getfileinfooptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要读取的文件路径 (本地路径) |\n@| digestAlgorithm | \"md5\" \\| \"sha1\" | 是 | - | - | md5 / sha1 |\n@| success | (res: [GetFileInfoSuccessResult](#getfileinfosuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetFileInfoSuccessResult 的属性值 @getfileinfosuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| digest | string | 是 | - | - | - |\n| size | number | 是 | - | - | - |\n| errMsg | string | 是 | - | - | - |\n\n\n##### getFileInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### stat(options) @stat\n\n获取文件 Stats 对象\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [StatOptions](#statoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| path | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 文件/目录路径 (本地路径) |\n@| recursive | boolean | 是 | - | - | 是否递归获取目录下的每个文件的 Stats 信息 |\n@| success | (res: [StatSuccessResult](#statsuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### StatSuccessResult 的属性值 @statsuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n| stats | Array\\<[FileStats](#filestats-values)\\> | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| path | string | 是 | - | - | - |\n@| stats | [Stats](#stats-values) | 是 | - | - | - |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| mode | number | 是 | - | - | 文件的类型和存取的权限，对应 POSIX stat.st_mode 注意android中，文件类型只包含是否是目录与文件， 另外在android中这里的权限指的是当前进程对文件或者文件夹是否有读，写，执行的权限， 这里没有与 POSIX stat.st_mode对应的组，其他人等相关权限的数据返回,只有所有者的相关权限 |\n@@| size | number | 是 | - | - | 文件大小，单位：B，对应 POSIX stat.st_size |\n@@| lastAccessedTime | number | 是 | - | - | 文件最近一次被存取或被执行的时间，UNIX 时间戳，对应 POSIX stat.st_atime 注意：android中由于系统限制无法获取该数据 |\n@@| lastModifiedTime | number | 是 | - | - | 文件最后一次被修改的时间，UNIX 时间戳，对应 POSIX stat.st_mtime |\n\n##### Stats 的方法 @stats-values \n\n##### isDirectory() @isdirectory\n\n判断当前文件是否一个目录\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n###### isDirectory 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### isFile() @isfile\n\n判断当前文件是否一个普通文件\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n###### isFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n\n##### stat 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### statSync(path, recursive) @statsync\n\nFileSystemManager.stat 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| path | string | 是 | - | - | 文件/目录路径 (本地路径) |\n| recursive | boolean | 是 | - | - | 是否递归获取目录下的每个文件的 Stats 信息 | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[FileStats](#filestats-values)\\> |\n \n\n##### statSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### appendFile(options) @appendfile\n\n在文件结尾追加内容\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **AppendFileOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要追加内容的文件路径 (本地路径) |\n@| encoding | \"ascii\" \\| \"base64\" \\| \"utf-8\" | 是 | - | - | 指定写入文件的字符编码
支持:ascii base64 utf-8 |\n@| data | string | 是 | - | - | 要追加的文本 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### appendFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### appendFileSync(filePath, data, encoding) @appendfilesync\n\nFileSystemManager.appendFile 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filePath | string | 是 | - | - | 要追加内容的文件路径 (本地路径) |\n| data | string | 是 | - | - | 要追加的文本 |\n| encoding | string | 是 | - | - | 指定写入文件的字符编码支持:ascii base64 utf-8 | \n\n\n##### appendFileSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### saveFile(options) @savefile\n\n保存临时文件到本地。此接口会移动临时文件，因此调用成功后，tempFilePath 将不可用。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SaveFileOptions](#savefileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| tempFilePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 临时存储文件路径 (本地路径) |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) \\| null | 否 | - | - | 要存储的文件路径 (本地路径) |\n@| success | (res: [SaveFileSuccessResult](#savefilesuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SaveFileSuccessResult 的属性值 @savefilesuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| savedFilePath | string | 是 | - | - | 存储后的文件路径 (本地路径) |\n\n\n##### saveFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### saveFileSync(tempFilePath, filePath?) @savefilesync\n\nFileSystemManager.saveFile 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tempFilePath | string | 是 | - | - | 临时存储文件路径 (本地路径) |\n| filePath | string \\| null | 否 | - | - | 要存储的文件路径 (本地路径) | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| string |\n \n\n##### saveFileSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### removeSavedFile(options) @removesavedfile\n\n删除该小程序下已保存的本地缓存文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **RemoveSavedFileOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 需要删除的文件路径 (本地路径) |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### removeSavedFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### unzip(options) @unzip\n\n解压文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UnzipFileOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| zipFilePath | string | 是 | - | - | 源文件路径，支持本地路径, 只可以是 zip 压缩文件 |\n@| targetPath | string | 是 | - | - | 目标目录路径, 支持本地路径 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### unzip 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### getSavedFileList(options) @getsavedfilelist\n\n获取该已保存的本地缓存文件列表\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetSavedFileListOptions](#getsavedfilelistoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (res: [GetSavedFileListResult](#getsavedfilelistresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetSavedFileListResult 的属性值 @getsavedfilelistresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| fileList | Array\\ | 是 | - | - | - |\n\n\n##### getSavedFileList 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### truncate(options) @truncate\n\n对文件内容进行截断操作\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **TruncateFileOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要截断的文件路径 (本地路径) |\n@| length | number | 是 | - | - | 截断位置，默认0。如果 length 小于文件长度（字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除； 如果 length 大于文件长度，不做处理 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### truncate 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### truncateSync(filePath, length?) @truncatesync\n\n对文件内容进行截断操作 (truncate 的同步版本)\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filePath | string | 是 | - | - | 要截断的文件路径 (本地路径) |\n| length | number | 否 | - | - | 截断位置，默认0。如果 length 小于文件长度（字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；如果 length 大于文件长度，不做处理 | \n\n\n##### truncateSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### readCompressedFile(options) @readcompressedfile\n\n读取指定压缩类型的本地文件内容\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ReadCompressedFileOptions](#readcompressedfileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要读取的文件的路径 (本地用户文件或代码包文件)，app-android平台支持代码包文件目录 |\n@| compressionAlgorithm | string | 是 | - | - | 文件压缩类型，目前仅支持 'br'。 |\n@| success | (res: [ReadCompressedFileResult](#readcompressedfileresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### ReadCompressedFileResult 的属性值 @readcompressedfileresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | string | 是 | - | - | - |\n\n\n##### readCompressedFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### readCompressedFileSync(filePath, compressionAlgorithm) @readcompressedfilesync\n\n同步读取指定压缩类型的本地文件内容\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filePath | string | 是 | - | - | 要读取的文件的路径 (本地用户文件或代码包文件)，app-android平台支持代码包文件目录 |\n| compressionAlgorithm | string | 是 | - | - | 文件压缩类型，目前仅支持 'br'。 | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| string |\n \n\n##### readCompressedFileSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### open(options) @open\n\n打开文件，返回文件描述符\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [OpenFileOptions](#openfileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要追加内容的文件路径 (本地路径) |\n@| flag | \"a\" \\| \"ax\" \\| \"a+\" \\| \"ax+\" \\| \"r\" \\| \"r+\" \\| \"w\" \\| \"wx\" \\| \"w+\" \\| \"wx\" \\| \"wx+\" | 是 | - | - | 文件系统标志，默认值: 'r' |\n@| success | (res: [OpenFileSuccessResult](#openfilesuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### OpenFileSuccessResult 的属性值 @openfilesuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| fd | string | 是 | - | - | - |\n\n\n##### open 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### openSync(options) @opensync\n\n同步打开文件，返回文件描述符\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **OpenFileSyncOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要追加内容的文件路径 (本地路径) |\n@| flag | \"a\" \\| \"ax\" \\| \"a+\" \\| \"ax+\" \\| \"r\" \\| \"r+\" \\| \"w\" \\| \"wx\" \\| \"w+\" \\| \"wx\" \\| \"wx+\" | 是 | - | - | 文件系统标志，默认值: 'r' | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| string |\n \n\n##### openSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### write(options) @write\n\n写入文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [WriteOptions](#writeoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fd | string | 是 | - | - | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |\n@| data | string | 是 | - | - | 写入的内容 |\n@| encoding | \"ascii\" \\| \"base64\" \\| \"utf-8\" | 是 | - | - | 指定写入文件的字符编码
支持:ascii base64 utf-8 |\n@| success | (res: [WriteResult](#writeresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### WriteResult 的属性值 @writeresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| bytesWritten | number | 是 | - | - | 实际被写入到文件中的字节数（注意，被写入的字节数不一定与被写入的字符串字符数相同） |\n\n\n##### write 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### writeSync(options) @writesync\n\n同步写入文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **WriteSyncOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fd | string | 是 | - | - | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |\n@| data | string | 是 | - | - | 写入的内容 |\n@| encoding | \"ascii\" \\| \"base64\" \\| \"utf-8\" | 是 | - | - | 指定写入文件的字符编码
支持:ascii base64 utf-8 | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [WriteResult](#writeresult-values) |\n \n\n##### writeSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### closeSync(options) @closesync\n\n同步关闭文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **CloseSyncOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fd | string | 是 | - | - | 需要被关闭的文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 | \n\n\n##### closeSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### fstat(options) @fstat\n\n获取文件的状态信息\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [FStatOptions](#fstatoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fd | string | 是 | - | - | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |\n@| success | (res: [FStatSuccessResult](#fstatsuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### FStatSuccessResult 的属性值 @fstatsuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| stats | [Stats](#stats-values) | 是 | - | - | Stats 对象，包含了文件的状态信息 |\n\n\n##### fstat 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### fstatSync(options) @fstatsync\n\n同步获取文件的状态信息\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **FStatSyncOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fd | string | 是 | - | - | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [Stats](#stats-values) |\n \n\n##### fstatSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### ftruncate(options) @ftruncate\n\n对文件内容进行截断操作\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **FTruncateFileOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fd | string | 是 | - | - | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |\n@| length | number | 是 | - | - | 截断位置，默认0。如果 length 小于文件长度（字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除； 如果 length 大于文件长度，不做处理 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### ftruncate 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### ftruncateSync(options) @ftruncatesync\n\n同步对文件内容进行截断操作\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **FTruncateFileSyncOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fd | string | 是 | - | - | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |\n@| length | number | 是 | - | - | 截断位置，默认0。如果 length 小于文件长度（字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除； 如果 length 大于文件长度，不做处理 | \n\n\n##### ftruncateSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### readZipEntry(options) @readzipentry\n\n读取压缩包内的文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ReadZipEntryOptions](#readzipentryoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要读取的压缩包的路径 (本地路径)，app-android平台支持代码包文件目录 |\n@| encoding | \"ascii\" \\| \"base64\" \\| \"utf-8\" | 是 | - | - | 统一指定读取文件的字符编码，只在 entries 值为\"all\"时有效。
如果 entries 值为\"all\"且不传 encoding，则以 string 格式读取文件的内容 |\n@| entries | Array\\<**EntryItem**\\> \\| null | 否 | - | - | 要读取的压缩包内的文件列表（当不传入时表示读取压缩包内所有文件） |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| path | string | 是 | - | - | 压缩包内文件路径 |\n@@| encoding | \"ascii\" \\| \"base64\" \\| \"base64\" | 是 | - | - | 指定写入文件的字符编码
支持:ascii base64 utf-8 |\n@| success | (res: [EntriesResult](#entriesresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### EntriesResult 的属性值 @entriesresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| result | Map\\ | 是 | - | - | 文件路径 |\n\n\n##### readZipEntry 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n \n","compatibility":"### getFileSystemManager 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.file.filemanager.getFileSystemManager)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-file-system-manager/get-file-system-manager.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"getUniverifyManager":{"name":"## uni.getUniverifyManager() @getuniverifymanager","description":"获取一键登录管理对象","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [UniverifyManager](#univerifymanager-values) |\n\n#### UniverifyManager 的方法 @univerifymanager-values \n\n#### preLogin(options) @prelogin\n预登录\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [PreLoginOptions](#preloginoptions-values) | 是 | - | - | 预登录参数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | () => void | 否 | - | - | - |\n@| fail | (err: [PreLoginFail](#preloginfail-values)) => void | 否 | - | - | - |\n@| complete | (res: any) => void | 否 | - | - | - | \n\n##### PreLoginFail 的属性值 @preloginfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1000 \\| 1001 \\| 1002 \\| 1004 \\| 4001 \\| 30004 \\| 30005 \\| 30006 | 是 | - | - | 1000 当前应用appid尚未开通uni一键登录
1001 应用所有者账号信息异常，请检查账号一键登录服务是否正常
1002 应用所有者账号信息异常，请检查账号余额是否充足
1004 uni一键登录应用不存在
4001 参数异常
30004 其他错误
30005 预登录失败
30006 一键登录失败 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n\n##### preLogin 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.99 | 4.18 | - |\n\n\n#### login(options) @login\n登录\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [LoginOptions](#loginoptions-values) | 是 | - | - | 登录参数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| univerifyStyle | **UniverifyStyle** | 否 | - | - | 登录页样式 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| fullScreen | boolean | 否 | - | - | 是否全屏 |\n@@| logoPath | string | 否 | - | - | logo路径 |\n@@| backgroundColor | string | 否 | - | - | 登录页背景色 |\n@@| loginBtnText | string | 否 | - | - | 登录按钮文字 |\n@| success | (res: [LoginSuccess](#loginsuccess-values)) => void | 否 | - | - | - |\n@| fail | (err: [LoginFail](#loginfail-values)) => void | 否 | - | - | - |\n@| complete | (res: any) => void | 否 | - | - | - | \n\n##### LoginSuccess 的属性值 @loginsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| openId | string | 是 | - | - | 登录授权唯一标识 |\n| accessToken | string | 是 | - | - | token |\n\n##### LoginFail 的属性值 @loginfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1000 \\| 1001 \\| 1002 \\| 1004 \\| 4001 \\| 30004 \\| 30005 \\| 30006 | 是 | - | - | 1000 当前应用appid尚未开通uni一键登录
1001 应用所有者账号信息异常，请检查账号一键登录服务是否正常
1002 应用所有者账号信息异常，请检查账号余额是否充足
1004 uni一键登录应用不存在
4001 参数异常
30004 其他错误
30005 预登录失败
30006 一键登录失败 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n\n##### login 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.99 | 4.18 | - |\n\n\n#### close() @close\n关闭登录页\n\n\n##### close 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.99 | 4.18 | - |\n\n\n#### isPreLoginValid() @ispreloginvalid\n预登录是否有效\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n##### isPreLoginValid 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.99 | 4.18 | - |\n\n \n","compatibility":"### getUniverifyManager 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.99 | 4.18 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/univerify.html#univerifymanager)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.login_verify.univerify.getUniverifyManager)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-univerify-manager/get-univerify-manager.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"getFacialRecognitionMetaInfo":{"name":"## uni.getFacialRecognitionMetaInfo() @getfacialrecognitionmetainfo","description":"获取阿里云实人认证meta info","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| string |\n \n","compatibility":"### getFacialRecognitionMetaInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.login_verify.facial-recognition-verify.getFacialRecognitionMetaInfo)\n"},"startFacialRecognitionVerify":{"name":"## uni.startFacialRecognitionVerify(faceStyle) @startfacialrecognitionverify","description":"启动人脸识别","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| faceStyle | [StartFacialRecognitionVerifyOptions](#startfacialrecognitionverifyoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| certifyId | string | 是 | - | - | certifyId 调用实人认证的id |\n@| progressBarColor | string \\| null | 否 | - | - | 活体检测页面的进度条颜色。 |\n@| screenOrientation | \"land\" \\| \"port\" | 否 | \"port\" | | 认证时屏幕方向
- land 横屏
- port 竖屏 |\n@| success | (res: [StartFacialRecognitionVerifySuccess](#startfacialrecognitionverifysuccess-values)) => void \\| null | 否 | - | - | 成功回调 |\n@| fail | (res: [IFacialRecognitionVerifyError](#ifacialrecognitionverifyerror-values)) => void \\| null | 否 | - | - | 失败回调 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 完成回调 | \n\n##### StartFacialRecognitionVerifySuccess 的属性值 @startfacialrecognitionverifysuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | 错误码 |\n| errSubject | string | 是 | - | - | 调用API的名称 |\n| errMsg | string | 是 | - | - | 错误的详细信息 |\n| cause | **SourceError** | 否 | - | - | 错误来源 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| subject | string \\| null | 否 | - | - | 源错误模块名称 |\n@| message | string | 是 | - | - | 源错误描述信息 |\n@| code | number | 是 | - | - | 源错误的错误码 |\n@| name | string | 是 | - | - | - |\n@| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | |\n\n##### IFacialRecognitionVerifyError 的属性值 @ifacialrecognitionverifyerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 10010 \\| 10012 \\| 10011 \\| 10013 \\| 10020 \\| 10001 \\| 10002 | 是 | - | - | 错误码
- 10001 certifyId 不能为空
- 10002 \"当前设备不支持\"
- 10010 刷脸异常
- 10012 网络异常
- 10011 验证中断
- 10013 刷脸验证失败
- 10020 设备设置时间异常 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### startFacialRecognitionVerify 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.login_verify.facial-recognition-verify.startFacialRecognitionVerify)\n"},"facial-recognition-verify":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/facial-recognition-verify/facial-recognition-verify.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"createRewardedVideoAd":{"name":"## uni.createRewardedVideoAd(option) @createrewardedvideoad","description":"创建激励视频广告对象","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| option | **CreateRewardedVideoAdOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| adpid | string | 是 | - | - | 广告位 id |\n@| urlCallback | **UrlCallbackOptions** \\| null | 否 | - | - | 服务器回调透传参数 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| userId | string \\| null | 否 | - | - | 透传到服务器端的userId |\n@@| extra | string \\| null | 否 | - | - | 透传到服务器端的extra，不推荐设置过于复杂的字符串 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [RewardedVideoAd](#rewardedvideoad-values) |\n\n#### RewardedVideoAd 的方法 @rewardedvideoad-values \n\n#### show() @show\n\n广告加载成功之后，调用此方法展示广告\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\ |\n \n\n##### show 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### load() @load\n\n加载广告\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\ |\n \n\n##### load 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### destroy() @destroy\n\n销毁广告\n\n\n##### destroy 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### onLoad(callback) @onload\n\n绑定广告 load 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: any) => void | 是 | - | - | - | \n\n\n##### onLoad 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### offLoad(callback) @offload\n\n解除绑定 load 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: any) => void | 是 | - | - | - | \n\n\n##### offLoad 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### onError(callback) @onerror\n\n绑定 error 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [IUniAdError](#iuniaderror-values)) => void | 是 | - | - | - | \n\n##### IUniAdError 的属性值 @iuniaderror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | 错误码 - -5001 广告位标识adpid为空，请传入有效的adpid - -5002 无效的广告位标识adpid，请使用正确的adpid - -5003 广告位未开通广告，请在广告平台申请并确保已审核通过 - -5004 无广告模块，打包时请配置要使用的广告模块 - -5005 广告加载失败，请稍后重试 - -5006 广告已经展示过了，请重新加载 - -5007 广告不可用或已过期，请重新请求 - -5008 广告不可用或已过期，请重新请求 - -5009 广告类型不符，请检查后再试 - -5011 打包或开通的渠道，不支持此类型广告 - -5013 广告播放失败，请重新加载 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n\n##### onError 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### offError(callback) @offerror\n\n解除绑定 error 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [IUniAdError](#iuniaderror-values)) => void | 是 | - | - | - | \n\n\n##### offError 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### onClose(callback) @onclose\n\n绑定 close 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [VideoAdClose](#videoadclose-values)) => void | 是 | - | - | - | \n\n##### VideoAdClose 的属性值 @videoadclose-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| isEnded | boolean | 是 | - | - | true标识广告播放完毕或者达到发放奖励的条件 |\n\n\n##### onClose 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### offClose(callback) @offclose\n\n解除绑定 close 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [VideoAdClose](#videoadclose-values)) => void | 是 | - | - | - | \n\n\n##### offClose 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### onAdClicked(callback) @onadclicked\n\n绑定广告可点击屏幕区域事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: any) => void | 是 | - | - | - | \n\n\n##### onAdClicked 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### onVerify(callback) @onverify\n\n绑定 verify 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)) => void | 是 | - | - | - | \n\n\n##### onVerify 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n","compatibility":"### createRewardedVideoAd 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.0 | - | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ad.createRewardedVideoAd)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/rewarded-video-ad/rewarded-video-ad.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"requestPayment":{"name":"## uni.requestPayment(options) @requestpayment","description":"请求支付","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [RequestPaymentOptions](#requestpaymentoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| provider | string | 是 | - | - | 支付服务提供商，通过 [uni.getProvider](https://doc.dcloud.net.cn/uni-app-x/api/get-provider.html) 获取,目前支持支付宝支付(alipay),微信支付(wxpay) |\n@| orderInfo | string | 是 | - | - | 订单数据 |\n@| success | (result: [RequestPaymentSuccess](#requestpaymentsuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [IRequestPaymentFail](#irequestpaymentfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### RequestPaymentSuccess 的属性值 @requestpaymentsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | any \\| null | 否 | - | - | |\n\n##### IRequestPaymentFail 的属性值 @irequestpaymentfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 700600 \\| 701100 \\| 701110 \\| 700601 \\| 700602 \\| 700603 \\| 700000 \\| 700604 \\| 700800 \\| 700801 | 是 | - | - | 错误码
- 700600 正在处理中，支付结果未知（有可能已经支付成功），请查询商家订单列表中订单的支付状态
- 701100 订单支付失败。
- 701110 重复请求。
- 700601 用户中途取消。
- 700602 网络连接出错。
- 700603 支付结果未知（有可能已经支付成功），请查询商家订单列表中订单的支付状态。
- 700000 其它支付错误。
- 700604 微信没有安装。
- 700800 没有配置对应的URL Scheme。
- 700801 没有配置对应的universal Link。 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### requestPayment 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.02 | 4.18 | x |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/plugins/payment.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.payment.requestPayment)\n","example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/request-payment/request-payment.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\r\n\r\n\r\n\r\n\n\n```"},"createWebviewContext":{"name":"## uni.createWebviewContext(webviewId, component?) @createwebviewcontext","description":"创建 web-view 组件的上下文对象，用于操作 web-view 的行为。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| webviewId | [string.WebviewIdString](/uts/data-type.md#ide-string) | 是 | - | - | - |\n| component | ComponentPublicInstance \\| null | 否 | - | - | | \n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [WebviewContext](#webviewcontext-values) \\| null | 否 |\n\n#### WebviewContext 的方法 @webviewcontext-values \n\n#### back() @back\n后退到 web-view 组件网页加载历史的上一页，如果不存在上一页则没有任何效果。\n\n\n##### back 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n\n\n#### forward() @forward\n前进到 web-view 组件网页加载历史的下一页，如果不存在下一页则没有任何效果。\n\n\n##### forward 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n\n\n#### reload() @reload\n重新加载 web-view 组件当前页面。\n\n\n##### reload 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n\n\n#### stop() @stop\n停止加载 web-view 组件当前网页，该方法不能阻止已经加载的 html 文档，但是能够阻止未完成的图片及延迟加载的资源。\n\n\n##### stop 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n\n\n#### evalJS(js) @evaljs\n在网页中执行指定的js脚本，在 uvue 页面中可通过此方法向 web-view 组件加载的页面发送数据\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| js | string | 是 | - | - | - | \n\n\n##### evalJS 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n\n \n","compatibility":"### createWebviewContext 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.component.create-webview-context)\n"},"createVideoContext":{"name":"## uni.createVideoContext(videoId, component?) @createvideocontext","description":"创建并返回 video 上下文 videoContext 对象","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| videoId | [string.VideoIdString](/uts/data-type.md#ide-string) | 是 | - | - | - |\n| component | ComponentPublicInstance \\| null | 否 | - | - | | \n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [VideoContext](#videocontext-values) \\| null | 否 |\n\n#### VideoContext 的方法 @videocontext-values \n\n#### play() @play\n播放\n\n\n##### play 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n\n\n#### pause() @pause\n暂停\n\n\n##### pause 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n\n\n#### seek(position) @seek\n跳转到指定位置\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| position | number | 是 | - | - | 跳转到指定位置(秒) | \n\n\n##### seek 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n\n\n#### stop() @stop\n停止视频\n\n\n##### stop 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n\n\n#### sendDanmu(danmu) @senddanmu\n发送弹幕\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| danmu | **Danmu** | 是 | - | - | text, color |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| text | string \\| null | 否 | - | - | 弹幕文字 |\n@| color | string \\| null | 否 | - | - | 弹幕颜色 |\n@| time | number \\| null | 否 | - | - | 显示时刻 | \n\n\n##### sendDanmu 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n\n\n#### playbackRate(rate) @playbackrate\n设置倍速播放\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| rate | number | 是 | - | - | , 支持倍率 0.5/0.8/1.0/1.25/1.5 | \n\n\n##### playbackRate 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n\n\n#### requestFullScreen(direction?) @requestfullscreen\n进入全屏\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| direction | **RequestFullScreenOptions** | 否 | - | - | , 0\\|正常竖向, 90\\|屏幕逆时针90度, -90\\|屏幕顺时针90度 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| direction | number \\| null | 否 | - | | direction
- 0: 正常竖向
- 90: 屏幕逆时针90度
- -90: 屏幕顺时针90度 | \n\n\n##### requestFullScreen 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n\n\n#### exitFullScreen() @exitfullscreen\n退出全屏\n\n\n##### exitFullScreen 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n\n \n","compatibility":"### createVideoContext 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/video-context?id=createVideoContext)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.component.create-video-context)\n"},"createMapContext":{"name":"## uni.createMapContext(mapId, currentComponent?) @createmapcontext","description":"\n创建并返回 map 上下文 mapContext 对象\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| mapId | string | 是 | - | - | - |\n| currentComponent | ComponentPublicInstance | 否 | - | - | - | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [MapContext](#mapcontext-values) |\n\n#### MapContext 的方法 @mapcontext-values \n\n#### getCenterLocation(options) @getcenterlocation\n\n获取当前地图中心的经纬度，返回的是 gcj02 坐标系，可以用于 uni.openLocation\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [MapContextGetCenterLocationOptions](#mapcontextgetcenterlocationoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (result: [LocationObject](#locationobject-values)) => void | 否 | - | - | 接口调用成功的回调函数 ，res = { longitude: \"经度\", latitude: \"纬度\"} |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### LocationObject 的属性值 @locationobject-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| latitude | number | 是 | - | - | 纬度，浮点数，范围为-90~90，负数表示南纬 |\n| longitude | number | 是 | - | - | 经度，范围为-180~180，负数表示西经 |\n\n\n##### getCenterLocation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### moveToLocation(options) @movetolocation\n\n将地图中心移动到当前定位点，需要配合map组件的show-location使用\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextMoveToLocationOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| latitude | number | 否 | - | - | 纬度，浮点数，范围为-90~90，负数表示南纬 |\n@| longitude | number | 否 | - | - | 经度，范围为-180~180，负数表示西经 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### moveToLocation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### translateMarker(options) @translatemarker\n\n平移marker，带动画\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [MapContextTranslateMarkerOptions](#mapcontexttranslatemarkeroptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| markerId | number | 是 | - | - | 指定marker |\n@| destination | [LocationObject](#locationobject-values) | 是 | - | - | 指定marker移动到的目标点 |\n@| autoRotate | boolean | 否 | - | - | 移动过程中是否自动旋转marker |\n@| rotate | number | 否 | - | - | marker的旋转角度 |\n@| moveWithRotate | boolean | 否 | - | - | 平移和旋转同时进行，默认值false（仅微信小程序2.13.0支持） |\n@| duration | number | 否 | - | - | 动画持续时长，默认值1000ms，平移与旋转分别计算 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### MapContextTranslateMarkerOptions 的方法 @mapcontexttranslatemarkeroptions-values \n\n##### animationEnd(result) @animationend\n\n动画结束回调函数\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| result | any | 是 | - | - | - | \n\n\n###### animationEnd 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n\n##### translateMarker 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### includePoints(options) @includepoints\n\n缩放视野展示所有经纬度\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextIncludePointsOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| points | Array\\<[LocationObject](#locationobject-values)\\> | 是 | - | - | 要显示在可视区域内的坐标点列表，[{latitude, longitude}\\] |\n@| padding | Array\\ | 否 | - | - | 坐标点形成的矩形边缘到地图边缘的距离，单位像素。格式为\\[上,右,下,左]安卓上只能识别数组第一项，上下左右的padding一致。开发者工具暂不支持padding参数。 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### includePoints 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### getRegion(options) @getregion\n\n获取当前地图的视野范围\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [MapContextGetRegionOptions](#mapcontextgetregionoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (result: [MapContextGetRegionResult](#mapcontextgetregionresult-values)) => void | 否 | - | - | 接口调用成功的回调函数，res = {southwest, northeast}，西南角与东北角的经纬度 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### MapContextGetRegionResult 的属性值 @mapcontextgetregionresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| southwest | [LocationObject](#locationobject-values) | 是 | - | - | 西南角的经纬度 |\n| northeast | [LocationObject](#locationobject-values) | 是 | - | - | 东北角的经纬度 |\n\n\n##### getRegion 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### getScale(options) @getscale\n\n获取当前地图的缩放级别\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [MapContextGetScaleOptions](#mapcontextgetscaleoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (result: [MapContextGetScaleResult](#mapcontextgetscaleresult-values)) => void | 否 | - | - | 接口调用成功的回调函数，res = {scale} |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### MapContextGetScaleResult 的属性值 @mapcontextgetscaleresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| scale | number | 是 | - | - | 地图缩放级别 |\n\n\n##### getScale 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### addCustomLayer(options) @addcustomlayer\n\n添加个性化图层\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextAddCustomLayerOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| layerId | string | 是 | - | - | 个性化图层id |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### addCustomLayer 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### addGroundOverlay(options) @addgroundoverlay\n\n创建自定义图片图层，图片会随着地图缩放而缩放\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextAddGroundOverlayOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| id | string | 是 | - | - | 图片图层 id |\n@| src | string | 是 | - | - | 图片路径，支持网络图片、临时路径、代码包路径 |\n@| bounds | **Bounds** | 是 | - | - | 图片覆盖的经纬度范围 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| southwest | [LocationObject](#locationobject-values) | 是 | - | - | 西南角的经纬度 |\n@@| northeast | [LocationObject](#locationobject-values) | 是 | - | - | 东北角的经纬度 |\n@| visible | boolean | 否 | - | - | 是否可见 |\n@| zIndex | number | 否 | - | - | 图层绘制顺序 |\n@| opacity | number | 否 | - | - | 图层透明度 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### addGroundOverlay 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### addMarkers(options) @addmarkers\n\n添加 marker\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextAddMarkersOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| markers | Array\\ | 是 | - | - | 同传入 map 组件的 marker 属性 |\n@| clear | boolean | 是 | - | - | 是否先清空地图上所有 marker |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### addMarkers 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### fromScreenLocation(options) @fromscreenlocation\n\n获取屏幕上的点对应的经纬度，坐标原点为地图左上角\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextFromScreenLocationOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| x | number | 是 | - | - | x 坐标值 |\n@| y | number | 是 | - | - | y 坐标值 |\n@| success | (result: [LocationObject](#locationobject-values)) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### fromScreenLocation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### initMarkerCluster(options) @initmarkercluster\n\n初始化点聚合的配置，未调用时采用默认配置\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextInitMarkerClusterOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| enableDefaultStyle | boolean | 是 | - | - | 启用默认的聚合样式 |\n@| zoomOnClick | boolean | 是 | - | - | 点击已经聚合的标记点时是否实现聚合分离 |\n@| gridSize | number | 是 | - | - | 聚合算法的可聚合距离，即距离小于该值的点会聚合至一起，以像素为单位 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### initMarkerCluster 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### moveAlong(options) @movealong\n\n沿指定路径移动 marker，用于轨迹回放等场景。动画完成时触发回调事件，若动画进行中，对同一 marker 再次调用 moveAlong 方法，前一次的动画将被打断。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextMoveAlongOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| markerId | number | 是 | - | - | 指定 marker |\n@| path | Array\\<[LocationObject](#locationobject-values)\\> | 是 | - | - | 移动路径的坐标串，坐标点格式 {longitude, latitude} |\n@| autoRotate | boolean | 否 | - | - | 根据路径方向自动改变 marker 的旋转角度 |\n@| duration | number | 是 | - | - | 平滑移动的时间 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### moveAlong 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### openMapApp(options) @openmapapp\n\n拉起地图APP选择导航。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextOpenMapAppOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| destination | string | 是 | - | - | 目的地名称 |\n@| latitude | number | 是 | - | - | 目的地纬度 |\n@| longitude | number | 是 | - | - | 目的地经度 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### openMapApp 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### removeCustomLayer(options) @removecustomlayer\n\n移除个性化图层\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextRemoveCustomLayerOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| layerId | string | 是 | - | - | 个性化图层id |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### removeCustomLayer 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### removeGroundOverlay(options) @removegroundoverlay\n\n移除自定义图片图层\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextRemoveGroundOverlayOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| id | string | 是 | - | - | 图片图层 id |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### removeGroundOverlay 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### removeMarkers(options) @removemarkers\n\n移除 marker\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextRemoveMarkersOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| markerIds | Array\\ | 是 | - | - | 要被删除的marker的id属性组成的数组 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### removeMarkers 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### setCenterOffset(options) @setcenteroffset\n\n设置地图中心点偏移，向后向下为增长，屏幕比例范围(0.25~0.75)，默认偏移为[0.5, 0.5\\]\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextSetCenterOffsetOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| offset | Array\\ | 是 | - | - | 偏移量，两位数组 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### setCenterOffset 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### toScreenLocation(options) @toscreenlocation\n\n获取经纬度对应的屏幕坐标，坐标原点为地图左上角。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextToScreenLocationOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| latitude | number | 是 | - | - | 纬度 |\n@| longitude | number | 是 | - | - | 经度 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### toScreenLocation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### updateGroundOverlay(options) @updategroundoverlay\n\n更新自定义图片图层。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextUpdateGroundOverlayOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| id | string | 是 | - | - | 图片图层 id |\n@| src | string | 是 | - | - | 图片路径，支持网络图片、临时路径、代码包路径 |\n@| bounds | [Bounds](#bounds-values) | 是 | - | - | 图片路径，支持网络图片、临时路径、代码包路径 |\n@| visible | boolean | 否 | - | - | 是否可见 |\n@| zIndex | number | 否 | - | - | 图层绘制顺序 |\n@| opacity | number | 否 | - | - | 图层透明度 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### updateGroundOverlay 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### on(event, callback) @on\n\n监听地图事件。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| event | \"markerClusterCreate\" \\| \"markerClusterClick\" | 是 | - | - | - |\n| callback | (args?: Array\\) => any | 是 | - | - | - | \n\n\n##### on 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### $getAppMap() @$getappmap\n\n获取原生地图对象 plus.maps.Map\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n##### $getAppMap 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n","compatibility":"### createMapContext 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |\n","tutorial":"\n### 参见\n- [createMapContext](https://doc.dcloud.net.cn/uni-app-x/api/create-map-context.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.component.create-map-context)\n"},"getProvider":{"name":"## uni.getProvider(options) @getprovider","description":"\n获取服务供应商","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetProviderOptions](#getprovideroptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| service | string | 是 | - | - | 服务类型，可取值“payment” - payment: 支付 (Alipay、Wxpay) |\n@| success | (result: [GetProviderSuccess](#getprovidersuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调 |\n@| fail | (result: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetProviderSuccess 的属性值 @getprovidersuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| service | string | 是 | - | - | 服务类型 - payment: 支付 |\n| provider | Array\\ | 是 | - | - | 得到的服务供应商 |\n| providers | Array\\<**UniProvider**\\> | 是 | - | | 得到的服务供应商服务对象 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| id | string | 是 | - | - | 服务供应商标识 |\n@| description | string | 是 | - | - | 服务供应商描述 |\n@| isAppExist | boolean | 是 | - | - | 判断服务供应商依赖的App是否安装 |\n| errMsg | string | 是 | - | - | 描述信息 |\n","returnValue":"","compatibility":"### getProvider 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.11 | 4.18 | 4.05 |\n","tutorial":"\n### 参见\n- [getProvider](https://doc.dcloud.net.cn/uni-app-x/api/get-provider.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.tripartite.get-provider)\n"},"get-provider":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-provider/get-provider.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\r\n\r\n\r\n\r\n\n\n```"},"general_type":{"name":"## 通用类型\n","param":"### GeneralCallbackResult \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | 错误信息 |\n"}} \ No newline at end of file +{"getApp":{"name":"## getApp() @getapp","description":"`getApp()` 函数用于获取当前应用实例，可通过应用实例调用 App.uvue methods 中定义的方法。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n","compatibility":"### getApp 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/tutorial/page.html#getapp)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.global.get-app)\n"},"get-app":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-app/get-app.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-app/get-app\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { state, setLifeCycleNum } from '@/store/index.uts'\r\n\r\n type MyGlobalData = {\r\n str : string,\r\n num : number,\r\n bool : boolean,\r\n obj : UTSJSONObject,\r\n null : string | null,\r\n arr : number[],\r\n mySet : string[],\r\n myMap : UTSJSONObject,\r\n func : () => string\r\n }\r\n\r\n export default {\r\n data() {\r\n return {\r\n originGlobalData: {\r\n str: '',\r\n num: 0,\r\n bool: false,\r\n obj: {\r\n str: '',\r\n num: 0,\r\n bool: false\r\n } as UTSJSONObject,\r\n null: null,\r\n arr: [] as number[],\r\n mySet: [] as string[],\r\n myMap: {},\r\n func: () : string => ''\r\n } as MyGlobalData,\r\n originGlobalDataFuncRes: '',\r\n newGlobalData: {\r\n str: '',\r\n num: 0,\r\n bool: false,\r\n obj: {\r\n str: '',\r\n num: 0,\r\n bool: false\r\n } as UTSJSONObject,\r\n null: null,\r\n arr: [] as number[],\r\n mySet: [] as string[],\r\n myMap: {},\r\n func: () : string => ''\r\n } as MyGlobalData,\r\n newGlobalDataFuncRes: '',\r\n lifeCycleNum: 0,\r\n }\r\n },\r\n onReady() {\r\n this.lifeCycleNum = state.lifeCycleNum\r\n },\r\n methods: {\r\n getGlobalData() {\r\n const app = getApp()\r\n\r\n this.originGlobalData.str = app.globalData.str\r\n this.originGlobalData.num = app.globalData.num\r\n this.originGlobalData.bool = app.globalData.bool\r\n this.originGlobalData.obj = app.globalData.obj\r\n this.originGlobalData.null = app.globalData.null\r\n this.originGlobalData.arr = app.globalData.arr\r\n app.globalData.mySet.forEach((value : string) => {\r\n this.originGlobalData.mySet.push(value)\r\n })\r\n app.globalData.myMap.forEach((value : any, key : string) => {\r\n this.originGlobalData.myMap[key] = value\r\n })\r\n this.originGlobalData.func = app.globalData.func\r\n this.originGlobalDataFuncRes = this.originGlobalData.func()\r\n },\r\n setGlobalData() {\r\n const app = getApp()\r\n\r\n app.globalData.str = 'new globalData str'\r\n app.globalData.num = 100\r\n app.globalData.bool = true\r\n app.globalData.obj = {\r\n str: 'new globalData obj str',\r\n num: 200,\r\n bool: true\r\n }\r\n app.globalData.null = 'not null'\r\n app.globalData.arr = [1, 2, 3]\r\n app.globalData.mySet = new Set(['a', 'b', 'c'])\r\n app.globalData.myMap = new Map([\r\n ['a', 1],\r\n ['b', 2],\r\n ['c', 3]\r\n ])\r\n app.globalData.func = () : string => {\r\n return 'new globalData func'\r\n }\r\n\r\n this.newGlobalData.str = app.globalData.str\r\n this.newGlobalData.num = app.globalData.num\r\n this.newGlobalData.bool = app.globalData.bool\r\n this.newGlobalData.obj = app.globalData.obj\r\n this.newGlobalData.null = app.globalData.null\r\n this.newGlobalData.arr = app.globalData.arr\r\n app.globalData.mySet.forEach((value : string) => {\r\n this.newGlobalData.mySet.push(value)\r\n })\r\n app.globalData.myMap.forEach((value : any, key : string) => {\r\n this.newGlobalData.myMap[key] = value\r\n })\r\n this.newGlobalData.func = app.globalData.func\r\n this.newGlobalDataFuncRes = this.newGlobalData.func()\r\n },\r\n _increasetLifeCycleNum: function () {\r\n const app = getApp()\r\n app.increasetLifeCycleNum()\r\n this.lifeCycleNum = state.lifeCycleNum\r\n },\r\n // 自动化测试\r\n setLifeCycleNum(num : number) {\r\n setLifeCycleNum(num)\r\n }\r\n },\r\n }\r\n\n```\n:::"},"getCurrentPages":{"name":"## getCurrentPages() @getcurrentpages","description":"`getCurrentPages()` 函数用于获取当前页面栈的实例，以数组形式按栈的顺序给出，数组中的元素为页面实例，第一个元素为首页，最后一个元素为当前页面。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[Page](#page-values)\\> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| route | string | 是 | - | - | 页面的路由地址 |\n@| options | Map\\ | 是 | - | - | 页面的路由参数信息，目前web端options类型为Object，后续可能会调整 |\n#### Page 的方法 @page-values \n\n#### $getPageStyle() @$getpagestyle\n获取当前页面样式 \\
包含 pages.json 页面下的 style 节点属性和根节点 globalStyle 属性\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) |\n \n\n##### $getPageStyle 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | 4.13 | 4.13 |\n\n\n##### 参见\n- [$getPageStyle](https://doc.dcloud.net.cn/uni-app-x/api/get-current-pages.html#getPageStyle)\n\n#### $setPageStyle(style) @$setpagestyle\n设置当前页面样式 \\
支持 pages.json 页面下的 style 节点属性和根节点 globalStyle 属性\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| style | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | - | 如果属性名存在，且类型为UTSJSONObject返回对应的结果，不存在返回null | \n\n\n##### $setPageStyle 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | 4.13 | 4.13 |\n\n\n##### 参见\n- [$setPageStyle](https://doc.dcloud.net.cn/uni-app-x/api/get-current-pages.html#setPageStyle)\n \n","compatibility":"### getCurrentPages 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/tutorial/page.html#getcurrentpages)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.global.get-current-pages)\n"},"get-current-pages":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-current-pages/get-current-pages.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-current-pages/get-current-pages\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { PageStyleItem, PageStyleArray } from './page-style.uts';\r\n\r\n class Page {\r\n constructor(public route : string) {\r\n }\r\n }\r\n\r\n export default {\r\n data() {\r\n return {\r\n checked: false,\r\n pages: [] as Page[],\r\n PageStyleArray: PageStyleArray as PageStyleItem[],\r\n currentPageStyle: {} as UTSJSONObject,\r\n }\r\n },\r\n computed: {\r\n pageStyleText() : string {\r\n return JSON.stringify(this.currentPageStyle)\r\n }\r\n },\r\n onLoad() {\r\n this.getPageStyle();\r\n },\r\n onPullDownRefresh() {\r\n setTimeout(() => {\r\n uni.stopPullDownRefresh()\r\n }, 2000)\r\n },\r\n methods: {\r\n startPullDownRefresh() {\r\n uni.startPullDownRefresh()\r\n },\r\n _getCurrentPages: function () {\r\n this.pages.length = 0\r\n const pages = getCurrentPages()\r\n this.pages.push(new Page(pages[0].route))\r\n if (this.pages[0].route.includes('/tabBar/')) {\r\n this.checked = true\r\n }\r\n for (let i = 1; i < pages.length; i++) {\r\n this.pages.push(new Page(pages[i].route))\r\n if (pages[i].route.includes('/tabBar/')) {\r\n this.checked = false\r\n }\r\n }\r\n },\r\n /// get-set-page-style\r\n radioChange(key : string, e : RadioGroupChangeEvent) {\r\n this.setStyleValue(key, e.detail.value);\r\n },\r\n sliderChange(key : string, e : UniSliderChangeEvent) {\r\n this.setStyleValue(key, e.detail.value);\r\n },\r\n switchChange(key : string, e : UniSwitchChangeEvent) {\r\n this.setStyleValue(key, e.detail.value);\r\n },\r\n setStyleValue(key : string, value : any) {\r\n const style = {}\r\n style[key] = value\r\n this.setPageStyle(style)\r\n this.getPageStyle()\r\n },\r\n getPageStyle() : UTSJSONObject {\r\n const pages = getCurrentPages();\r\n const currentPage = pages[pages.length - 1];\r\n this.currentPageStyle = currentPage.$getPageStyle()\r\n return this.currentPageStyle;\r\n },\r\n setPageStyle(style : UTSJSONObject) {\r\n console.log('setPageStyle:', style);\r\n const pages = getCurrentPages();\r\n const currentPage = pages[pages.length - 1];\r\n currentPage.$setPageStyle(style);\r\n },\r\n // getCurrentPage(): Page {\r\n // const pages = getCurrentPages();\r\n // const currentPage = pages[pages.length - 1];\r\n // return currentPage;\r\n // }\r\n },\r\n }\r\n\n```\n:::"},"$on":{"name":"## uni.$on(eventName, callback) @$on","description":"监听自定义事件。事件可以由 uni.$emit 触发。回调函数会接收 uni.$emit 传递的参数。
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| eventName | string | 是 | - | - | - |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"","compatibility":"### $on 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [$on](https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#on)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.event-bus.$on)\n"},"$once":{"name":"## uni.$once(eventName, callback) @$once","description":"监听一个自定义事件。事件只触发一次，在第一次触发之后移除事件监听器。
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| eventName | string | 是 | - | - | - |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"","compatibility":"### $once 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [$once](https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#once)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.event-bus.$once)\n"},"$off":{"name":"## uni.$off(eventName, callback?) @$off","description":"移除自定义事件监听器。如果提供了事件名和回调，则只移除这个回调的监听器。
4.13+ 开始支持第二个参数为可选，如果仅提供事件名，则移除该事件的所有监听器。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| eventName | string | 是 | - | - | - |\n| callback | () => void \\| null | 否 | - | - | | \n","returnValue":"","compatibility":"### $off 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [$off](https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#off)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.event-bus.$off)\n"},"$emit":{"name":"## uni.$emit(eventName, args?) @$emit","description":"触发自定义事件，附加的参数会传递给事件监听器。
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| eventName | string | 是 | - | - | - |\n| args | any \\| null | 否 | - | - | | \n","returnValue":"","compatibility":"### $emit 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [$emit](https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.event-bus.$emit)\n"},"event-bus":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/event-bus/event-bus.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/event-bus/event-bus\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n log: [] as string[],\r\n }\r\n },\r\n methods: {\r\n fn(res : string) {\r\n this.log.push(res)\r\n },\n fn2(res : string) {\n this.log.push(res)\n },\r\n on() {\r\n uni.$on('test', this.fn)\r\n },\n on2() {\n uni.$on('test', this.fn2)\n },\r\n once() {\r\n uni.$once('test', this.fn)\r\n },\r\n off() {\r\n uni.$off('test', this.fn)\r\n },\n offAll() {\n uni.$off('test')\n },\r\n emit() {\r\n uni.$emit('test', 'msg:' + Date.now())\r\n },\r\n clear() {\r\n this.log.length = 0\r\n },\r\n },\r\n }\r\n\n```\n:::"},"addInterceptor":{"name":"## uni.addInterceptor(name, interceptor) @addinterceptor","description":"添加拦截器","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | 需要拦截的 API 名称 |\n| interceptor | Interceptor | 是 | - | - | 拦截器 | \n","returnValue":"","compatibility":"### addInterceptor 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.97 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.interceptor.addInterceptor)\n"},"removeInterceptor":{"name":"## uni.removeInterceptor(name, interceptor?) @removeinterceptor","description":"删除拦截器","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | 需要删除拦截器的 API 名称 |\n| interceptor | Interceptor \\| null | 否 | - | - | 拦截器 | \n","returnValue":"","compatibility":"### removeInterceptor 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.97 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.interceptor.removeInterceptor)\n"},"interceptor":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/interceptor/interceptor.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/interceptor/interceptor\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n const interceptor = {\r\n invoke: function (options : NavigateToOptions) {\r\n console.log('拦截 navigateTo 接口传入参数为：', options)\r\n const url = './page2'\r\n uni.showToast({\r\n title: `重定向到页面:${url}`\r\n })\r\n options.url = url\r\n },\r\n success: function (res : NavigateBackSuccess) {\r\n console.log('拦截 navigateTo 接口 success 返回参数为：', res)\r\n },\r\n fail: function (err : NavigateToFail) {\r\n console.log('拦截 navigateTo 接口 fail 返回参数为：', err)\r\n },\r\n complete: function (res : NavigateToComplete) {\r\n console.log('拦截 navigateTo 接口 complete 返回参数为：', res)\r\n }\r\n } as Interceptor\r\n export default {\r\n data() {\r\n return {\r\n msg: \"会跳转到测试页面1\"\r\n }\r\n },\r\n beforeUnmount() {\r\n // 移除 navigateTo 所有拦截器\r\n uni.removeInterceptor('navigateTo')\r\n },\r\n methods: {\r\n addInterceptor() {\r\n uni.addInterceptor('navigateTo', interceptor)\r\n uni.showToast({\r\n title: '页面跳转已拦截'\r\n })\r\n this.msg = \"，路由被劫持到测试页面2\"\r\n },\r\n removeInterceptor() {\r\n uni.removeInterceptor('navigateTo', interceptor)\r\n uni.showToast({\r\n title: '拦截器已移除'\r\n })\r\n this.msg = \"会跳转到测试页面1\"\r\n },\r\n navigateTo() {\r\n uni.navigateTo({\r\n url: './page1',\r\n success(res) {\r\n console.log('res:', res)\r\n },\r\n fail(err) {\r\n console.error('err:', err)\r\n },\r\n complete(res) {\r\n console.log('res:', res)\r\n }\r\n })\r\n }\r\n }\r\n }\r\n\n```\n:::"},"getLaunchOptionsSync":{"name":"## uni.getLaunchOptionsSync() @getlaunchoptionssync","description":"获取本次启动时的参数。返回值与App.onLaunch的回调参数一致
","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **OnLaunchOptions** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| path | string | 是 | - | - | - | \n","compatibility":"### getLaunchOptionsSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [getLaunchOptionsSync](https://doc.dcloud.net.cn/uni-app-x/api/get-launch-options-sync.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.get-launch-options-sync)\n"},"get-launch-options-sync":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-launch-options-sync/get-launch-options-sync.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-launch-options-sync/get-launch-options-sync\n>Template\n```vue\n\n\n\n\n```\n>Script\n```uts\n\nexport default {\n data() {\n return {\n checked: false,\n homePagePath: 'pages/tabBar/component',\n launchOptionsPath: '',\n }\n },\n methods: {\n getLaunchOptionsSync() {\n const launchOptions = uni.getLaunchOptionsSync()\n this.launchOptionsPath = launchOptions.path\n\n if (launchOptions.path == this.homePagePath) {\n this.checked = true\n }\n },\n },\n}\n\n```\n:::"},"exit":{"name":"## uni.exit(options?) @exit","description":"退出当前应用","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ExitOptions](#exitoptions-values) \\| null | 否 | - | - | uni.exit参数定义 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (res: [ExitSuccess](#exitsuccess-values)) => void \\| null | 否 | - | - | uni.exit成功回调函数定义 |\n@| fail | (res: [IExitError](#iexiterror-values)) => void \\| null | 否 | - | - | uni.exit失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.exit完成回调函数定义 | \n\n##### ExitSuccess 的属性值 @exitsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n\n##### IExitError 的属性值 @iexiterror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 12001 \\| 12002 | 是 | - | - | 错误码
- 12001: 系统不支持
- 12002: 未知错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### exit 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | x | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.exit)\n","example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/exit/exit.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n```"},"env":{"name":"## env","description":"","param":"### env 的属性值 @env-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| USER_DATA_PATH | string | 是 | - | | 应用专属存储空间的外置存储空间根目录下的files目录 |\n| CACHE_PATH | string | 是 | - | | 应用专属存储空间的外置存储空间根目录下的cache目录 |\n| SANDBOX_PATH | string | 是 | - | | 应用专属存储空间的外置存储空间根目录（caches/files） |\n","compatibility":"","returnValue":"","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.env)\n","example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/env/env.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"getPerformance":{"name":"## getPerformance","description":"返回一个Performance对象实例
","param":"### getPerformance 的方法 @getperformance-values \n\n### createObserver(callback) @createobserver\n创建全局性能事件监听器\n#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (entries: [PerformanceObserverEntryList](#performanceobserverentrylist-values)) => void | 是 | - | - | - | \n\n##### PerformanceObserverEntryList 的方法 @performanceobserverentrylist-values \n\n##### getEntries() @getentries\n该方法返回当前列表中的所有性能数据\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<**PerformanceEntry**\\> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| entryType | string | 是 | - | - | 指标类型 |\n@| name | string | 是 | - | - | 指标名称 |\n@| duration | number | 是 | - | - | 耗时 ms。仅对于表示阶段的指标有效。 |\n@| startTime | number | 是 | - | - | 开始时间，不同指标的具体含义会有差异。 |\n@| path | string \\| null | 否 | - | - | 页面路径。仅 render 和 navigation 类型指标有效。 |\n@| referrerPath | string \\| null | 否 | - | - | 页面跳转来源页面路径。仅 route 指标有效。 |\n@| pageId | number \\| null | 否 | - | - | path 对应页面实例 Id（随机生成，不保证递增）。仅 render/navigation 指标有效。 |\n@| referrerPageId | number \\| null | 否 | - | - | referrerPath对应页面实例 Id（随机生成，不保证递增）。仅 route 指标有效。 |\n@| navigationStart | number \\| null | 否 | - | - | 路由真正响应开始时间。仅 navigation 类型指标有效。 |\n@| navigationType | string \\| null | 否 | - | - | 路由详细类型，与路由方法对应。仅 navigation 类型指标有效。 |\n@| initDataRecvTime | number \\| null | 否 | - | - | 首次渲染参数在渲染层收到的时间。仅 firstRender 指标有效。 |\n@| viewLayerRenderEndTime | number \\| null | 否 | - | - | 渲染层执行渲染结束时间。仅 firstRender 指标有效。 | \n\n###### getEntries 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### getEntriesByType(entryType) @getentriesbytype\n获取当前列表中所有类型为 \\[entryType]的性能数据\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| entryType | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[PerformanceEntry](#performanceentry-values)\\> |\n \n\n###### getEntriesByType 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### getEntriesByName(name, entryType) @getentriesbyname\n获取当前列表中所有名称为 \\[name] 且类型为 [entryType]的性能数据\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - |\n| entryType | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[PerformanceEntry](#performanceentry-values)\\> |\n \n\n###### getEntriesByName 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### 返回值 \n\n| 类型 |\n| :- |\n| [PerformanceObserver](#performanceobserver-values) |\n\n##### PerformanceObserver 的方法 @performanceobserver-values \n\n##### observe(options) @observe\n开始监听\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **PerformanceObserverOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| buffered | boolean | 否 | - | - | - |\n@| entryTypes | Array\\ | 否 | - | - | - |\n@| type | string | 否 | - | - | - | \n\n\n###### observe 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### disconnect() @disconnect\n停止监听\n\n\n###### disconnect 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n\n#### createObserver 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n### getEntries() @getentries\n该方法返回当前缓冲区中的所有性能数据\n\n#### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[PerformanceEntry](#performanceentry-values)\\> |\n \n\n#### getEntries 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n### getEntriesByType(entryType) @getentriesbytype\n获取当前缓冲区中所有类型为 \\[entryType]的性能数据\n#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| entryType | string | 是 | - | - | - | \n\n#### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[PerformanceEntry](#performanceentry-values)\\> |\n \n\n#### getEntriesByType 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n### getEntriesByName(name, entryType) @getentriesbyname\n获取当前缓冲区中所有名称为 \\[name] 且类型为 [entryType]的性能数据\n#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - |\n| entryType | string | 是 | - | - | - | \n\n#### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[PerformanceEntry](#performanceentry-values)\\> |\n \n\n#### getEntriesByName 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n### setBufferSize(size) @setbuffersize\n设置缓冲区大小，默认缓冲 30 条性能数据\n#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| size | number | 是 | - | - | - | \n\n\n#### setBufferSize 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n","compatibility":"","returnValue":"","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.get-performance)\n"},"navigateTo":{"name":"## uni.navigateTo(options) @navigateto","description":"保留当前页面，跳转到应用内的某个页面
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [NavigateToOptions](#navigatetooptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| url | string ([string.PageURIString](/uts/data-type.md#ide-string)) | 是 | - | | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n@| events | any \\| null | 否 | - | | 页面间通信接口，用于监听被打开页面发送到当前页面的数据 |\n@| success | (result: AsyncApiSuccessResult) => void \\| null | 否 | - | | 接口调用成功的回调函数 |\n@| fail | (result: [NavigateToFail](#navigatetofail-values)) => void \\| null | 否 | - | | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void \\| null | 否 | - | | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### NavigateToFail 的属性值 @navigatetofail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | 路由错误码
- 4: 框架内部异常 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### navigateTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/router?id=navigateto)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.navigateTo)\n"},"reLaunch":{"name":"## uni.reLaunch(options) @relaunch","description":"关闭所有页面，打开到应用内的某个页面
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ReLaunchOptions](#relaunchoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| url | string ([string.PageURIString](/uts/data-type.md#ide-string)) | 是 | - | | 需要跳转的应用内页面路径 , 路径后可以带参数。参数与路径之间使用?分隔，参数键与参数值用=相连，不同参数用&分隔；如 'path?key=value&key2=value2'，如果跳转的页面路径是 tabBar 页面则不能带参数 |\n@| success | (result: AsyncApiSuccessResult) => void \\| null | 否 | - | | 接口调用成功的回调函数 |\n@| fail | (result: [ReLaunchFail](#relaunchfail-values)) => void \\| null | 否 | - | | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void \\| null | 否 | - | | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### ReLaunchFail 的属性值 @relaunchfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### reLaunch 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/router?id=relaunch)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.reLaunch)\n"},"navigateBack":{"name":"## uni.navigateBack(options?) @navigateback","description":"关闭当前页面，返回上一页面或多级页面
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [NavigateBackOptions](#navigatebackoptions-values) \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| delta | number \\| null | 否 | - | | 返回的页面数，如果 delta 大于现有页面数，则返回到首页 |\n@| success | (result: AsyncApiSuccessResult) => void \\| null | 否 | - | | 接口调用成功的回调函数 |\n@| fail | (result: [NavigateBackFail](#navigatebackfail-values)) => void \\| null | 否 | - | | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void \\| null | 否 | - | | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### NavigateBackFail 的属性值 @navigatebackfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### navigateBack 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/router?id=navigateback)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.navigateBack)\n"},"redirectTo":{"name":"## uni.redirectTo(options) @redirectto","description":"关闭当前页面，跳转到应用内的某个页面
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [RedirectToOptions](#redirecttooptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| url | string ([string.PageURIString](/uts/data-type.md#ide-string)) | 是 | - | | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n@| success | (result: AsyncApiSuccessResult) => void \\| null | 否 | - | | 接口调用成功的回调函数 |\n@| fail | (result: [RedirectToFail](#redirecttofail-values)) => void \\| null | 否 | - | | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void \\| null | 否 | - | | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### RedirectToFail 的属性值 @redirecttofail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### redirectTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/router?id=redirectto)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.redirectTo)\n"},"switchTab":{"name":"## uni.switchTab(options) @switchtab","description":"跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SwitchTabOptions](#switchtaboptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| url | string ([string.PageURIString](/uts/data-type.md#ide-string)) | 是 | - | | 需要跳转的 tabBar 页面的路径，路径后不能带参数 |\n@| success | (result: AsyncApiSuccessResult) => void \\| null | 否 | - | | 接口调用成功的回调函数 |\n@| fail | (result: [SwitchTabFail](#switchtabfail-values)) => void \\| null | 否 | - | | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void \\| null | 否 | - | | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SwitchTabFail 的属性值 @switchtabfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### switchTab 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/router?id=switchtab)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.navigator.switchTab)\n"},"navigator":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/navigator/navigator.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/navigator/navigator\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { state, setLifeCycleNum } from '@/store/index.uts'\r\n\r\n export default {\r\n data() {\r\n return {\r\n onLoadTime: 0,\r\n onShowTime: 0,\r\n onReadyTime: 0,\r\n onHideTime: 0,\r\n }\r\n },\r\n onLoad() {\r\n this.onLoadTime = Date.now()\r\n console.log('onLoad', this.onLoadTime)\r\n },\r\n onShow() {\r\n this.onShowTime = Date.now()\r\n console.log('onShow', this.onShowTime)\r\n },\r\n onReady() {\r\n this.onReadyTime = Date.now()\r\n console.log('onReady', this.onReadyTime)\r\n },\r\n onHide() {\r\n this.onHideTime = Date.now()\r\n console.log('onHide', this.onHideTime)\r\n },\r\n onBackPress(options : OnBackPressOptions) : boolean | null {\r\n console.log('onBackPress', Date.now())\r\n console.log('onBackPress from', options.from)\r\n return null\r\n },\r\n onUnload() {\r\n console.log('onUnload', Date.now())\r\n },\r\n methods: {\r\n reLaunch() {\r\n uni.reLaunch({\r\n url: '/pages/tabBar/component',\r\n success(result) {\r\n console.log('reLaunch success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('reLaunch fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('reLaunch complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateTo() {\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1?data=Hello',\r\n success(result) {\r\n console.log('navigateTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateTo fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateToErrorPage() {\r\n uni.navigateTo({\r\n url: '/pages/error-page/error-page',\r\n success(result) {\r\n console.log('navigateTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n fail(error) {\r\n console.log('navigateTo fail', error.errMsg)\r\n uni.showToast({\r\n title: error.errMsg,\r\n icon: 'none',\r\n })\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n complete(result) {\r\n console.log('navigateTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateToDebounce() {\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1?data=debounce',\r\n success(result) {\r\n console.log('navigateTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateTo fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1?data=debounce',\r\n success(result) {\r\n console.log('navigateTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n fail(error) {\r\n console.log('navigateTo fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n complete(result) {\r\n console.log('navigateTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n // 自动化测试\r\n navigateToRelativePath1() {\r\n uni.navigateTo({\r\n url: 'new-page/new-page-1?data=new-page/new-page-1',\r\n success() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail() {\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n // 自动化测试\r\n navigateToRelativePath2() {\r\n uni.navigateTo({\r\n url: './new-page/new-page-1?data=./new-page/new-page-1',\r\n success() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail() {\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n // 自动化测试\r\n navigateToRelativePath3() {\r\n uni.navigateTo({\r\n url: '../navigator/new-page/new-page-1?data=../navigator/new-page/new-page-1',\r\n success() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail() {\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete() {\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateBack() {\r\n uni.navigateBack({\r\n success(result) {\r\n console.log('navigateBack success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateBack fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateBack complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n navigateBackWithDelta1() {\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1',\r\n success() {\r\n uni.navigateBack({\r\n delta: 1,\r\n success(result) {\r\n console.log('navigateBack success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateBack fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateBack complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n })\r\n },\r\n navigateBackWithDelta100() {\r\n uni.navigateTo({\r\n url: '/pages/API/navigator/new-page/new-page-1',\r\n success() {\r\n uni.navigateBack({\r\n delta: 100,\r\n success(result) {\r\n console.log('navigateBack success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('navigateBack fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('navigateBack complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n })\r\n },\r\n redirectTo() {\r\n uni.redirectTo({\r\n url: '/pages/API/navigator/new-page/new-page-1?data=Hello',\r\n success(result) {\r\n console.log('redirectTo success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('redirectTo fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('redirectTo complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n switchTab() {\r\n uni.switchTab({\r\n url: '/pages/tabBar/template',\r\n success(result) {\r\n console.log('switchTab success', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail(error) {\r\n console.log('switchTab fail', error.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete(result) {\r\n console.log('switchTab complete', result.errMsg)\r\n // 自动化测试\r\n setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n })\r\n },\r\n // 自动化测试\r\n getLifeCycleNum() : number {\r\n return state.lifeCycleNum\r\n },\r\n // 自动化测试\r\n setLifeCycleNum(num : number) {\r\n setLifeCycleNum(num)\r\n },\r\n },\r\n }\r\n\n```\n:::"},"setNavigationBarColor":{"name":"## uni.setNavigationBarColor(options) @setnavigationbarcolor","description":"设置导航条、状态栏颜色
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SetNavigationBarColorOptions](#setnavigationbarcoloroptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| frontColor | \"#ffffff\" \\| \"#000000\" | 是 | - | | 前景颜色值，包括按钮、标题、状态栏的颜色，仅支持 #ffffff 和 #000000 |\n@| backgroundColor | [string.ColorString](/uts/data-type.md#ide-string) | 是 | - | | 背景颜色值，有效值为十六进制颜色 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | | 接口调用成功的回调函数 |\n@| fail | (error: [SetNavigationBarColorFail](#setnavigationbarcolorfail-values)) => void | 否 | - | | 接口调用失败的回调函数 |\n@| complete | (res: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetNavigationBarColorFail 的属性值 @setnavigationbarcolorfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### setNavigationBarColor 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [setNavigationBarColor](https://doc.dcloud.net.cn/uni-app-x/api/set-navigation-bar-color.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-navigation-bar-color)\n"},"set-navigation-bar-color":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/set-navigation-bar-color/set-navigation-bar-color.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/set-navigation-bar-color/set-navigation-bar-color\n>Template\n```vue\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { state, setLifeCycleNum } from '@/store/index.uts'\r\n\r\n export default {\r\n methods: {\r\n setNavigationBarColor1() {\r\n uni.setNavigationBarColor({\r\n frontColor: '#ffffff',\r\n backgroundColor: '#00ff00',\r\n success: () => {\r\n console.log('setNavigationBarColor success')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail: () => {\r\n console.log('setNavigationBarColor fail')\r\n this.setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete: () => {\r\n console.log('setNavigationBarColor complete')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n }\r\n })\r\n },\r\n setNavigationBarColor2() {\r\n uni.setNavigationBarColor({\r\n frontColor: '#000000',\r\n backgroundColor: '#ff0000',\r\n success: () => {\r\n console.log('setNavigationBarColor success')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n },\r\n fail: () => {\r\n console.log('setNavigationBarColor fail')\r\n this.setLifeCycleNum(state.lifeCycleNum - 1)\r\n },\r\n complete: () => {\r\n console.log('setNavigationBarColor complete')\r\n this.setLifeCycleNum(state.lifeCycleNum + 1)\r\n }\r\n })\r\n },\r\n // 自动化测试\r\n getLifeCycleNum() : number {\r\n return state.lifeCycleNum\r\n },\r\n // 自动化测试\r\n setLifeCycleNum(num : number) {\r\n setLifeCycleNum(num)\r\n },\r\n goNavbarLite() {\r\n uni.navigateTo({\r\n url: '/pages/template/navbar-lite/navbar-lite'\r\n })\r\n }\r\n },\r\n }\r\n\n```\n:::"},"setNavigationBarTitle":{"name":"## uni.setNavigationBarTitle(options) @setnavigationbartitle","description":"动态设置当前页面的标题
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SetNavigationBarTitleOptions](#setnavigationbartitleoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| title | string | 是 | - | | 页面标题 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | | 接口调用成功的回调函数 |\n@| fail | (error: [SetNavigationBarTitleFail](#setnavigationbartitlefail-values)) => void | 否 | - | | 接口调用失败的回调函数 |\n@| complete | (res: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetNavigationBarTitleFail 的属性值 @setnavigationbartitlefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### setNavigationBarTitle 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.97 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [setNavigationBarTitle](https://doc.dcloud.net.cn/uni-app-x/api/set-navigation-bar-title.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-navigation-bar-title)\n"},"set-navigation-bar-title":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/set-navigation-bar-title/set-navigation-bar-title.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/set-navigation-bar-title/set-navigation-bar-title\n>Template\n```vue\n\n\n\n\n```\n>Script\n```uts\n\n import { state, setLifeCycleNum } from '@/store/index.uts'\n\n export default {\n data() {\n return {\n newTitle: 'new title',\n longTitle: 'long title long title long title long title long title long title long title long title long title long title'\n }\n },\n methods: {\n setNavigationBarNewTitle() {\n uni.setNavigationBarTitle({\n title: this.newTitle,\n success: () => {\n console.log('setNavigationBarTitle success')\n this.setLifeCycleNum(state.lifeCycleNum + 1)\n },\n fail: () => {\n console.log('setNavigationBarTitle fail')\n this.setLifeCycleNum(state.lifeCycleNum - 1)\n },\n complete: () => {\n console.log('setNavigationBarTitle complete')\n this.setLifeCycleNum(state.lifeCycleNum + 1)\n }\n })\n },\n setNavigationBarLongTitle() {\n uni.setNavigationBarTitle({\n title: this.longTitle,\n success() {\n console.log('setNavigationBarTitle success')\n },\n fail() {\n console.log('setNavigationBarTitle fail')\n },\n complete() {\n console.log('setNavigationBarTitle complete')\n }\n })\n },\n // 自动化测试\n getLifeCycleNum() : number {\n return state.lifeCycleNum\n },\n // 自动化测试\n setLifeCycleNum(num : number) {\n setLifeCycleNum(num)\n }\n },\n }\n\n```\n:::"},"showTabBar":{"name":"## uni.showTabBar(options?) @showtabbar","description":"显示 tabBar
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ShowTabBarOptions](#showtabbaroptions-values) \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| animation | boolean | 否 | - | - | 是否需要动画效果 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [SetTabBarFail](#settabbarfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 100 \\| 200 | 是 | - | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### showTabBar 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [showTabBar](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#showtabbar)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.showTabBar)\n"},"hideTabBar":{"name":"## uni.hideTabBar(options?) @hidetabbar","description":"隐藏 tabBar
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [HideTabBarOptions](#hidetabbaroptions-values) \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| animation | boolean | 否 | - | - | 是否需要动画效果 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [SetTabBarFail](#settabbarfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 100 \\| 200 | 是 | - | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### hideTabBar 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [hideTabBar](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#hidetabbar)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.hideTabBar)\n"},"showTabBarRedDot":{"name":"## uni.showTabBarRedDot(options) @showtabbarreddot","description":"显示 tabBar 某一项的右上角的红点
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ShowTabBarRedDotOptions](#showtabbarreddotoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| index | number | 是 | - | - | tabBar的哪一项，从左边算起，索引从0开始 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [SetTabBarFail](#settabbarfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 100 \\| 200 | 是 | - | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### showTabBarRedDot 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [showTabBarRedDot](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#showtabbarreddot)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.showTabBarRedDot)\n"},"hideTabBarRedDot":{"name":"## uni.hideTabBarRedDot(options) @hidetabbarreddot","description":"隐藏 tabBar 某一项的右上角的红点
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [HideTabBarRedDotOptions](#hidetabbarreddotoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| index | number | 是 | - | - | tabBar的哪一项，从左边算起，索引从0开始 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [SetTabBarFail](#settabbarfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 100 \\| 200 | 是 | - | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### hideTabBarRedDot 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [hideTabBarRedDot](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#hidetabbarreddot)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.hideTabBarRedDot)\n"},"setTabBarBadge":{"name":"## uni.setTabBarBadge(options) @settabbarbadge","description":"为 tabBar 某一项的右上角添加文本
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SetTabBarBadgeOptions](#settabbarbadgeoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| index | number | 是 | - | - | tabBar的哪一项，从左边算起，索引从0开始 |\n@| text | string | 是 | - | - | 显示的文本，不超过 3 个半角字符 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [SetTabBarFail](#settabbarfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 100 \\| 200 | 是 | - | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### setTabBarBadge 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [setTabBarBadge](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#settabbarbadge)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.setTabBarBadge)\n"},"removeTabBarBadge":{"name":"## uni.removeTabBarBadge(options) @removetabbarbadge","description":"移除 tabBar 某一项右上角的文本
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [RemoveTabBarBadgeOptions](#removetabbarbadgeoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| index | number | 是 | - | - | tabBar的哪一项，从左边算起，索引从0开始 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [SetTabBarFail](#settabbarfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 100 \\| 200 | 是 | - | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### removeTabBarBadge 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [removeTabBarBadge](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#removetabbarbadge)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.removeTabBarBadge)\n"},"setTabBarStyle":{"name":"## uni.setTabBarStyle(options) @settabbarstyle","description":"动态设置 tabBar 的整体样式
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SetTabBarStyleOptions](#settabbarstyleoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| color | string ([string.ColorString](/uts/data-type.md#ide-string)) | 否 | - | - | tab 上的文字默认颜色 |\n@| selectedColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | 否 | - | - | tab 上的文字选中时的颜色 |\n@| backgroundColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | 否 | - | - | tab 的背景色 |\n@| backgroundImage | string | 否 | - | - | 图片背景 |\n@| backgroundRepeat | \"repeat\" \\| \"repeat-x\" \\| \"repeat-y\" \\| \"no-repeat\" | 否 | - | - | 背景图平铺方式
- repeat: 背景图片在垂直方向和水平方向平铺
- repeat-x: 背景图片在水平方向平铺，垂直方向拉伸
- repeat-y: 背景图片在垂直方向平铺，水平方向拉伸
- no-repeat: 背景图片在垂直方向和水平方向都拉伸 |\n@| borderStyle | string | 否 | - | - | tabbar上边框的颜色 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [SetTabBarFail](#settabbarfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 100 \\| 200 | 是 | - | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### setTabBarStyle 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [setTabBarStyle](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#settabbarstyle)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.setTabBarStyle)\n"},"setTabBarItem":{"name":"## uni.setTabBarItem(options) @settabbaritem","description":"动态设置 tabBar 某一项的内容
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SetTabBarItemOptions](#settabbaritemoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| index | number | 是 | - | - | tabBar 的哪一项，从左边算起，索引从0开始 |\n@| text | string | 否 | - | - | tab 上按钮文字 |\n@| iconPath | string | 否 | - | - | 图片路径 |\n@| selectedIconPath | string | 否 | - | - | 选中时的图片路径 |\n@| pagePath | string | 否 | - | - | 页面绝对路径 |\n@| iconfont | **SetTabBarItemIconFontOptions** | 否 | - | - | 字体图标，优先级高于 iconPath |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| text | string | 是 | - | - | 字库 Unicode 码 |\n@@| selectedText | string | 是 | - | - | 选中后字库 Unicode 码 |\n@@| fontSize | string | 否 | - | - | 字体图标字号(px) |\n@@| color | string | 否 | - | - | 字体图标颜色 |\n@@| selectedColor | string | 否 | - | - | 字体图标选中颜色 |\n@| visible | boolean | 否 | - | - | tab 是否显示 |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [SetTabBarFail](#settabbarfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SetTabBarFail 的属性值 @settabbarfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 100 \\| 200 | 是 | - | - | 错误码
- 100: TabBar 不存在
- 200: 参数错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### setTabBarItem 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [setTabBarItem](https://doc.dcloud.net.cn/uni-app-x/api/set-tabbar.html#settabbaritem)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.set-tabbar.setTabBarItem)\n"},"startPullDownRefresh":{"name":"## uni.startPullDownRefresh(options?) @startpulldownrefresh","description":"开始下拉刷新
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [StartPullDownRefreshOptions](#startpulldownrefreshoptions-values) \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [StartPullDownRefreshFail](#startpulldownrefreshfail-values)) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### StartPullDownRefreshFail 的属性值 @startpulldownrefreshfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### startPullDownRefresh 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.io/uni-app-x/api/pull-down-refresh.html#startpulldownrefresh)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.pull-down-refresh.startPullDownRefresh)\n"},"stopPullDownRefresh":{"name":"## uni.stopPullDownRefresh() @stoppulldownrefresh","description":"停止当前页面下拉刷新
","param":"","returnValue":"","compatibility":"### stopPullDownRefresh 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [stopPullDownRefresh](https://doc.dcloud.net.cn/uni-app-x/api/pull-down-refresh.html#stoppulldownrefresh)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.pull-down-refresh.stopPullDownRefresh)\n"},"pull-down-refresh":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/pull-down-refresh/pull-down-refresh.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/pull-down-refresh/pull-down-refresh\n>Template\n```vue\n\n\n\n\n\n```\n>Script\n```uts\n\n\texport default {\n\t\tdata() {\n\t\t\treturn {\n\t\t\t\tdata: [] as Array,\n\t\t\t\tloadMoreText: \"加载中...\",\n\t\t\t\tshowLoadMore: false,\n\t\t\t\tmax: 0\n\t\t\t}\n\t\t},\n\t\tonReady() {\n uni.startPullDownRefresh();\n\t\t\tthis.initData();\n\t\t},\n\t\tonReachBottom() {\n\t\t\tconsole.log(\"onReachBottom\");\n\t\t\tif (this.max > 40) {\n\t\t\t\tthis.loadMoreText = \"没有更多数据了!\"\n\t\t\t\treturn;\n\t\t\t}\n\t\t\tthis.showLoadMore = true;\n\t\t\tsetTimeout(() => {\n\t\t\t\tthis.setListData();\n\t\t\t}, 300);\n\t\t},\n\t\tonPullDownRefresh() {\n\t\t\tconsole.log('onPullDownRefresh');\n\t\t\tthis.initData();\n\t\t},\n\t\tmethods: {\n\t\t\tinitData(){\n\t\t\t\tsetTimeout(() => {\n\t\t\t\t\tthis.max = 0;\n\t\t\t\t\tthis.data = [];\n\t\t\t\t\tlet data:Array = [];\n\t\t\t\t\tthis.max += 20;\n\t\t\t\t\tfor (let i:number = this.max - 19; i < this.max + 1; i++) {\n\t\t\t\t\t\tdata.push(i)\n\t\t\t\t\t}\n\t\t\t\t\tthis.data = this.data.concat(data);\n\t\t\t\t\tuni.stopPullDownRefresh();\n\t\t\t\t}, 1000);\n\t\t\t},\n\t\t\tsetListData() {\n\t\t\t\tlet data:Array = [];\n\t\t\t\tthis.max += 10;\n\t\t\t\tfor (let i:number = this.max - 9; i < this.max + 1; i++) {\n\t\t\t\t\tdata.push(i)\n\t\t\t\t}\n\t\t\t\tthis.data = this.data.concat(data);\n\t\t\t}\n\t\t}\n\t}\n\n```\n:::"},"pageScrollTo":{"name":"## uni.pageScrollTo(options) @pagescrollto","description":"将页面滚动到目标位置
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [PageScrollToOptions](#pagescrolltooptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| scrollTop | number \\| null | 否 | - | - | 滚动到页面的目标位置 |\n@| selector | string \\| null | 否 | - | - | 选择器 |\n@| offsetTop | number \\| null | 否 | - | | 偏移距离，可以滚动到 selector 加偏移距离的位置 |\n@| duration | number \\| null | 否 | - | - | 滚动动画的时长 |\n@| success | (result: AsyncApiSuccessResult) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [PageScrollToFail](#pagescrolltofail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: [AsyncApiResult](#asyncapiresult-values)) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### PageScrollToFail 的属性值 @pagescrolltofail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### pageScrollTo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [pageScrollTo](https://doc.dcloud.net.cn/uni-app-x/api/page-scroll-to.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.page.page-scroll-to)\n"},"page-scroll-to":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/page-scroll-to/page-scroll-to.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/page-scroll-to/page-scroll-to\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: 'pageScrollTo',\n }\n },\n methods: {\n scrollTo() {\n uni.pageScrollTo({\n scrollTop: 100,\n duration: 300,\n success: () => {\n console.log('success')\n },\n })\n },\n scrollToElement() {\n uni.pageScrollTo({\n selector: '.custom-element',\n duration: 300,\n success: () => {\n console.log('success')\n },\n })\n },\n },\n }\n\n```\n:::"},"getElementById":{"name":"## uni.getElementById(id) @getelementbyid","description":"返回一个匹配特定 ID 的元素， 如果不存在，返回 null。\\
如果需要获取指定的节点类型，需要使用 as 进行类型转换。\\
ID 区分大小写，且应该是唯一的。如果存在多个匹配的元素，则返回第一个匹配的元素。
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| id | [string.IDString](/uts/data-type.md#ide-string) \\| string | 是 | - | - | - | \n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [UniElement](/dom/unielement.md) \\| null | 否 |\n \n","compatibility":"### getElementById 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [getElementById](https://doc.dcloud.net.cn/uni-app-x/api/get-element.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.dom.get-element.getElementById)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-element-by-id/get-element-by-id.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-element-by-id/get-element-by-id\n>Template\n```vue\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n checked: false,\r\n homePagePath: '/pages/tabBar/component',\r\n launchOptionsPath: '',\r\n }\r\n },\n methods: {\r\n getElementByNotExistId() : Element | null {\r\n return uni.getElementById('not-exist-id')\r\n },\r\n changePageHeadBackgroundColor() {\r\n const pageHead = uni.getElementById('page-head')!\r\n pageHead.style.setProperty('background-color', 'red')\r\n },\r\n changeTextColor() {\r\n const text = uni.getElementById('text')!\r\n text.style.setProperty('color', 'red')\r\n },\r\n changeViewStyle() {\r\n const view = uni.getElementById('view')\r\n if (view !== null) {\r\n view.style.setProperty('width', '90%')\r\n view.style.setProperty('height', '50px')\r\n view.style.setProperty('background-color', '#007AFF')\r\n }\r\n },\r\n goMultipleRootNode() {\r\n uni.navigateTo({ url: '/pages/API/get-element-by-id/get-element-by-id-multiple-root-node' })\r\n },\n //自动化测试获取text元素的offsetLeft属性值\n getTextOffsetLeft(): number {\n const text = uni.getElementById('text')!\n return text.offsetLeft\n }\r\n }\r\n }\r\n\n```\n:::"},"createSelectorQuery":{"name":"## uni.createSelectorQuery() @createselectorquery","description":"返回一个SelectorQuery对象实例
","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n\n#### SelectorQuery 的方法 @selectorquery-values \n\n#### in(component?) @in\n将选择器的选取范围更改为自定义组件component内\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| component | any \\| null | 否 | - | - | | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n##### in 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### select(selector) @select\n在当前页面下选择第一个匹配选择器selector的节点\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| selector | string | 是 | - | - | - | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [NodesRef](#nodesref-values) |\n\n##### NodesRef 的方法 @nodesref-values \n\n##### boundingClientRect(callback?) @boundingclientrect\n添加节点的布局位置的查询请求，相对于显示区域，以像素为单位\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: any) => void \\| null | 否 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n###### boundingClientRect 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### scrollOffset(callback) @scrolloffset\n添加节点的滚动位置查询请求，以像素为单位\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: any) => void | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n###### scrollOffset 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### fields(fields, callback) @fields\n获取节点的相关信息，需要获取的字段在fields中指定\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| fields | **NodeField** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| id | boolean \\| null | 否 | - | - | 是否返回节点 id |\n@| dataset | boolean \\| null | 否 | - | - | 是否返回节点 dataset |\n@| rect | boolean \\| null | 否 | - | - | 是否返回节点布局位置（left right top bottom） |\n@| size | boolean \\| null | 否 | - | - | 是否返回节点尺寸（width height） |\n@| scrollOffset | boolean \\| null | 否 | - | - | 是否返回节点的 scrollLeft scrollTop，节点必须是 scroll-view 或者 viewport |\n@| properties | Array\\ \\| null | 否 | - | - | 指定属性名列表，返回节点对应属性名的当前属性值（只能获得组件文档中标注的常规属性值，id class style 和事件绑定的属性值不可获取） |\n@| computedStyle | Array\\ \\| null | 否 | - | - | 指定样式名列表，返回节点对应样式名的当前值 |\n@| context | boolean \\| null | 否 | - | | 是否返回节点对应的 Context 对象 |\n| callback | (result: any) => void | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n###### fields 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### context(callback) @context\n添加节点的 Context 对象查询请求\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: any) => void | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n###### context 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |\n\n\n##### node(callback) @node\n获取 Node 节点实例。目前支持 Canvas 的获取。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: any) => void | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [SelectorQuery](#selectorquery-values) |\n \n\n###### node 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n\n##### select 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### selectAll(selector) @selectall\n在当前页面下选择匹配选择器selector的所有节点\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| selector | string | 是 | - | - | - | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [NodesRef](#nodesref-values) |\n \n\n##### selectAll 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### selectViewport() @selectviewport\n选择显示区域\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [NodesRef](#nodesref-values) |\n \n\n##### selectViewport 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### exec(callback) @exec\n执行所有的请求\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: Array\\) => void \\| null | 是 | - | - | - | \n\n##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [NodesRef](#nodesref-values) \\| null | 否 |\n \n\n##### exec 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n","compatibility":"### createSelectorQuery 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.91 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [createSelectorQuery](https://doc.dcloud.net.cn/uni-app-x/api/nodes-info.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.dom.nodes-info.createSelectorQuery)\n"},"nodes-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/nodes-info/nodes-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/nodes-info/nodes-info\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import nodeChild from './nodes-info-child.uvue'\r\n\r\n type NodeInfoType = {\r\n left : number | null,\r\n top : number | null,\r\n right : number | null,\r\n bottom : number | null,\r\n width : number | null,\r\n height : number | null,\r\n }\r\n\r\n export default {\r\n components: {\r\n nodeChild\r\n },\r\n data() {\r\n return {\r\n title: 'createSelectorQuery',\r\n nodeInfoList: [] as NodeInfoType[],\r\n // 仅用于自动化测试\r\n rootNodeInfo: null as NodeInfoType | null,\r\n //供自动化测试使用\r\n // resizeRectValid: false\r\n }\r\n },\r\n onResize() {\r\n //供自动化测试使用\r\n /* var rect12Element = uni.getElementById(\"rect-1-2\")\r\n if(rect12Element != null) {\r\n var domRect = rect12Element.getBoundingClientRect()\r\n if(domRect.width > 100) {\r\n this.resizeRectValid = true\r\n }\r\n } */\r\n },\r\n methods: {\r\n // 仅用于自动化测试\r\n getRootNodeInfo(selector : string) {\r\n uni.createSelectorQuery().select(selector).boundingClientRect().exec((ret) => {\r\n if (ret.length == 1) {\r\n const nodeInfo = ret[0] as NodeInfo;\r\n const nodeType = {\r\n left: nodeInfo.left,\r\n top: nodeInfo.top,\r\n right: nodeInfo.right,\r\n bottom: nodeInfo.bottom,\r\n width: nodeInfo.width,\r\n height: nodeInfo.height,\r\n } as NodeInfoType;\r\n this.rootNodeInfo = nodeType\r\n }\r\n })\r\n },\r\n getNodeInfo() {\r\n uni.createSelectorQuery().select('.rect1').boundingClientRect().exec((ret) => {\r\n this.nodeInfoList.length = 0\r\n const i = ret[0] as NodeInfo\r\n this.nodeInfoList.push({\r\n left: i.left,\r\n top: i.top,\r\n right: i.right,\r\n bottom: i.bottom,\r\n width: i.width,\r\n height: i.height,\r\n } as NodeInfoType)\r\n })\r\n },\r\n getAllNodeInfo() {\r\n uni.createSelectorQuery().selectAll('.rect').boundingClientRect().exec((ret) => {\r\n this.nodeInfoList.length = 0\r\n const array = ret[0] as NodeInfo[]\r\n array.forEach((i) => {\r\n this.nodeInfoList.push({\r\n left: i.left,\r\n top: i.top,\r\n right: i.right,\r\n bottom: i.bottom,\r\n width: i.width,\r\n height: i.height,\r\n } as NodeInfoType)\r\n })\r\n })\r\n }\r\n }\r\n }\r\n\n```\n:::"},"showActionSheet":{"name":"## uni.showActionSheet(options) @showactionsheet","description":"从底部向上弹出操作菜单","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ShowActionSheetOptions](#showactionsheetoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| title | string \\| null | 否 | - | - | 菜单标题 |\n@| alertText | string \\| null | 否 | - | - | 警示文案（同菜单标题, app无效） |\n@| itemList | Array\\ | 是 | - | - | 按钮的文字数组 |\n@| itemColor | [string.ColorString](/uts/data-type.md#ide-string) \\| null | 否 | - | - | 按钮的文字颜色，字符串格式（iOS默认为系统控件颜色） |\n@| popover | **Popover** \\| null | 否 | - | - | 大屏设备弹出原生选择按钮框的指示区域，默认居中显示 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| top | number | 是 | - | - | 指示区域坐标，使用原生 navigationBar 时一般需要加上 navigationBar 的高度 |\n@@| left | number | 是 | - | - | 指示区域坐标 |\n@@| width | number | 是 | - | - | 指示区域宽度 |\n@@| height | number | 是 | - | - | 指示区域高度 |\n@| success | (res: [ShowActionSheetSuccess](#showactionsheetsuccess-values)) => void \\| null | 否 | - | - | uni.showActionSheet成功回调函数定义 |\n@| fail | (res: [IPromptError](#iprompterror-values)) => void \\| null | 否 | - | - | uni.showActionSheet成功回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.showActionSheet成功回调函数定义 | \n\n##### ShowActionSheetSuccess 的属性值 @showactionsheetsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tapIndex | number \\| null | 否 | - | - | 用户点击的按钮，从上到下的顺序，从0开始 |\n\n##### IPromptError 的属性值 @iprompterror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1 \\| 1001 | 是 | - | - | 错误码
- 1\t 撤销
- 1001 请求参数非法 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### showActionSheet 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showactionsheet)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.prompt.showActionSheet)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/action-sheet/action-sheet.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/action-sheet/action-sheet\n>Template\n```vue\n\r\n\n\n```\n>Script\n```uts\n\r\n type ItemType = {\r\n value : string,\r\n name : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'action-sheet',\r\n itemColorCustom: false,\r\n itemContentLarge: false,\r\n itemNumLargeSelect: false,\n showErrorToast:true,\r\n items: [{\r\n value: '标题',\r\n name: '有标题'\r\n },\r\n {\r\n value: '',\r\n name: '无标题'\r\n },\r\n {\r\n value: '超长标题测试内容，测试超过显示最大范围之后的样式-超长标题测试内容，测试超过显示最大范围之后的样式',\r\n name: '超长标题'\r\n }\r\n ] as ItemType[],\r\n current: 0,\r\n }\r\n },\n onLoad(){\n uni.showActionSheet({\n title: \"onLoad 调用示例,请手动取消\",\n itemList:['item1', 'item2'],\n })\n },\r\n methods: {\n //自动化测试例专用\n jest_getWindowInfo() : GetWindowInfoResult {\n return uni.getWindowInfo();\n },\r\n radioChange(e : UniRadioGroupChangeEvent) {\r\n for (let i = 0; i < this.items.length; i++) {\r\n if (this.items[i].value === e.detail.value) {\r\n this.current = i;\r\n break;\r\n }\r\n }\r\n },\r\n itemContentLargeChange: function (e : UniSwitchChangeEvent) {\r\n this.itemContentLarge = e.detail.value\r\n },\r\n itemColorChange: function (e : UniSwitchChangeEvent) {\r\n this.itemColorCustom = e.detail.value\r\n },\r\n itemNumLargeChange: function (e : UniSwitchChangeEvent) {\r\n this.itemNumLargeSelect = e.detail.value\r\n },\r\n actionSheetTap() {\r\n\r\n let itemInfo = ['item1', 'item2', 'item3', 'item4']\r\n\r\n if (this.itemContentLarge) {\r\n itemInfo = ['两个黄鹂鸣翠柳，一行白鹭上青天。窗含西岭千秋雪，门泊东吴万里船', '水光潋滟晴方好,山色空蒙雨亦奇。 欲把西湖比西子,淡妆浓抹总相宜', '']\r\n }\n\n if (this.itemNumLargeSelect) {\r\n // 大量选项测试,不能超过6个元素 https://uniapp.dcloud.net.cn/api/ui/prompt.html#showactionsheet\r\n itemInfo = []\n for (var i = 1; i <= 10; i++) {\r\n itemInfo.push('两个黄鹂鸣翠柳，一行白鹭上青天');\r\n }\r\n }\r\n\r\n const that = this\r\n if (this.itemColorCustom) {\r\n uni.showActionSheet({\r\n title: this.items[this.current].value,\r\n itemList: itemInfo,\r\n itemColor: \"#ff00ff\",\r\n success: (e) => {\r\n console.log(e.tapIndex);\r\n uni.showToast({\r\n title: \"点击了第\" + e.tapIndex + \"个选项\",\r\n icon: \"none\"\r\n })\r\n },\r\n fail: (e) => {\n if(this.showErrorToast){\n uni.showToast({\n title: e.errMsg,\n icon: \"none\"\n })\n }\r\n console.log(e);\r\n }\r\n })\r\n } else {\r\n uni.showActionSheet({\r\n title: this.items[this.current].value,\r\n itemList: itemInfo,\r\n success: (e) => {\r\n console.log(e.tapIndex);\r\n uni.showToast({\r\n title: \"点击了第\" + e.tapIndex + \"个选项\",\r\n icon: \"none\"\r\n })\r\n },\r\n fail: (e) => {\r\n console.log(e);\n if(this.showErrorToast){\n uni.showToast({\n title: e.errMsg,\n icon: \"none\"\n })\n }\n }\r\n })\r\n }\r\n },\r\n }\r\n }\r\n\n```\n:::"},"showLoading":{"name":"## uni.showLoading(options) @showloading","description":"显示 loading 提示框, 需主动调用 uni.hideLoading 才能关闭提示框。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ShowLoadingOptions](#showloadingoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| title | string | 是 | - | - | 提示的内容，长度与 icon 取值有关。 |\n@| mask | boolean \\| null | 否 | - | - | 是否显示透明蒙层，防止触摸穿透，默认：false |\n@| success | (res: ShowLoadingSuccess) => void \\| null | 否 | - | - | uni.showLoading成功回调函数定义 |\n@| fail | (res: [IPromptError](#iprompterror-values)) => void \\| null | 否 | - | - | uni.showLoading失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.showLoading完成回调函数定义 | \n\n##### IPromptError 的属性值 @iprompterror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1 \\| 1001 | 是 | - | - | 错误码
- 1\t 撤销
- 1001 请求参数非法 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### showLoading 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showloading)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.prompt.showLoading)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/loading/loading.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/loading/loading\n>Template\n```vue\n\n\n\n```\n>Script\n```uts\n\n type ItemType = {\n value : string\n name : string\n }\n export default {\n data() {\n return {\n title: 'loading',\n items: [\n {\n value: 'null',\n name: '无标题',\n },\n {\n value: '三秒后自动关闭',\n name: '普通标题',\n },\n {\n value: '超长文本内容，测试超出范围-超长文本内容，测试超出范围-三秒后自动关闭',\n name: '长标题',\n },\n ] as ItemType[],\n current: 0,\n maskSelect: false,\n titleSelect: \"null\"\n }\n },\n onLoad(){\n uni.showLoading({\n \ttitle:'onLoad 调用示例,2秒后消失'\n })\n setTimeout(function() {\n uni.hideLoading()\n }, 2000);\n },\n methods: {\n //自动化测试例专用\n jest_getWindowInfo() : GetWindowInfoResult {\n return uni.getWindowInfo();\n },\n\n radioChange(e : UniRadioGroupChangeEvent) {\n const selected = this.items.find((item) : boolean => {\n return item.value == e.detail.value\n })\n if (selected != null) {\n this.titleSelect = selected.value\n }\n },\n maskChange: function (e : UniSwitchChangeEvent) {\n this.maskSelect = e.detail.value\n },\n showLoading: function () {\n\n console.log(this.titleSelect)\n if (this.titleSelect == \"null\") {\n uni.showLoading({\n title: \"\",\n mask: this.maskSelect\n });\n } else {\n uni.showLoading({\n title: this.titleSelect,\n mask: this.maskSelect\n });\n }\n setTimeout(() => {\n this.hideLoading();\n }, 3000);\n },\n hideLoading: function () {\n uni.hideLoading();\n }\n }\n }\n\n```\n:::"},"showModal":{"name":"## uni.showModal(options) @showmodal","description":"显示模态弹窗，可以只有一个确定按钮，也可以同时有确定和取消按钮。类似于一个API整合了 html 中：alert、confirm。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ShowModalOptions](#showmodaloptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| title | string \\| null | 否 | - | - | 提示的标题 |\n@| content | string \\| null | 否 | - | - | 提示的内容 |\n@| showCancel | boolean \\| null | 否 | true
是否显示取消按钮，默认为 true | - | |\n@| cancelText | string \\| null | 否 | - | - | 取消按钮的文字，默认为\"取消\" |\n@| cancelColor | [string.ColorString](/uts/data-type.md#ide-string) \\| null | 否 | - | - | 取消按钮的文字颜色，默认为\"#000000\" |\n@| confirmText | string \\| null | 否 | - | - | 确定按钮的文字，默认为\"确定\" |\n@| confirmColor | [string.ColorString](/uts/data-type.md#ide-string) \\| null | 否 | - | - | 确定按钮的文字颜色 |\n@| editable | boolean \\| null | 否 | false
是否显示输入框 | - | |\n@| placeholderText | string \\| null | 否 | - | - | 显示输入框时的提示文本 |\n@| success | (res: [ShowModalSuccess](#showmodalsuccess-values)) => void \\| null | 否 | - | - | uni.showModal成功回调函数定义 |\n@| fail | (res: [IPromptError](#iprompterror-values)) => void \\| null | 否 | - | - | uni.showModal失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.showModal完成回调函数定义 | \n\n##### ShowModalSuccess 的属性值 @showmodalsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| confirm | boolean | 是 | - | - | 为 true 时，表示用户点击了确定按钮 |\n| cancel | boolean | 是 | - | - | 为 true 时，表示用户点击了取消（用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭） |\n| content | string \\| null | 否 | - | - | editable 为 true 时，用户输入的文本 |\n\n##### IPromptError 的属性值 @iprompterror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1 \\| 1001 | 是 | - | - | 错误码
- 1\t 撤销
- 1001 请求参数非法 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### showModal 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showmodal)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.prompt.showModal)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/modal/modal.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/modal/modal\n>Template\n```vue\n\n\n\n\n```\n>Script\n```uts\n\n type ItemType = {\n value : string,\n name : string,\n }\n export default {\n data() {\n return {\n title: 'modal',\n showCancelSelect: false,\n cancelTextSelect: false,\n confirmTextSelect: false,\n editableSelect: false,\n placeholderTextSelect: false,\n exeRet: \"\",\n items: [{\n value: '标题',\n name: '有标题'\n },\n {\n value: '',\n name: '无标题'\n },\n {\n value: '超长标题测试内容，测试超过显示最大范围之后的样式-超长标题测试内容，测试超过显示最大范围之后的样式',\n name: '超长标题'\n }\n ] as ItemType[],\n current: 0\n }\n },\n onLoad() {\n uni.showModal({\n title: \"onLoad 调用示例,请手动取消\",\n showCancel: false\n })\n },\n methods: {\n //自动化测试例专用\n jest_getWindowInfo() : GetWindowInfoResult {\n return uni.getWindowInfo();\n },\n showCancelChange: function (e : UniSwitchChangeEvent) {\n this.showCancelSelect = e.detail.value\n },\n cancelTextChange: function (e : UniSwitchChangeEvent) {\n this.cancelTextSelect = e.detail.value\n },\n confirmTextChange: function (e : UniSwitchChangeEvent) {\n this.confirmTextSelect = e.detail.value\n },\n editableChange: function (e : UniSwitchChangeEvent) {\n this.editableSelect = e.detail.value\n },\n placeholderTextChange: function (e : UniSwitchChangeEvent) {\n this.placeholderTextSelect = e.detail.value\n },\n radioChange(e : UniRadioGroupChangeEvent) {\n for (let i = 0; i < this.items.length; i++) {\n if (this.items[i].value === e.detail.value) {\n this.current = i;\n break;\n }\n }\n },\n modalTap: function () {\n let cancelTextVal : string\n let cancelColorVal = ''\n if (this.cancelTextSelect) {\n cancelTextVal = \"修改后的取消文本\"\n cancelColorVal = \"#ff00ff\"\n } else {\n cancelTextVal = \"取消\"\n }\n\n let confirmTextVal = '确定'\n let confirmColorVal = ''\n if (this.confirmTextSelect) {\n confirmTextVal = \"修改后的确定文本\"\n confirmColorVal = \"#00ffff\"\n }\n\n let placeholderTextVal = ''\n let contentVal = \"弹窗内容，告知当前状态、信息和解决方法，描述文字尽量控制在三行内\"\n if (this.placeholderTextSelect) {\n placeholderTextVal = \"定制提示信息\"\n contentVal = \"\"\n }\n uni.showModal({\n title: this.items[this.current].value,\n editable: this.editableSelect,\n placeholderText: placeholderTextVal,\n content: contentVal,\n showCancel: this.showCancelSelect,\n cancelText: cancelTextVal,\n cancelColor: cancelColorVal,\n confirmText: confirmTextVal,\n confirmColor: confirmColorVal,\n success: (res) => {\n this.exeRet = JSON.stringify(res)\n },\n fail: (res) => {\n this.exeRet = JSON.stringify(res)\n }\n })\n }\n }\n }\n\n```\n:::"},"showToast":{"name":"## uni.showToast(options) @showtoast","description":"显示消息提示框","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ShowToastOptions](#showtoastoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| title | string | 是 | - | - | 提示的内容，长度与 icon 取值有关。 |\n@| icon | \"success\" \\| \"error\" \\| \"fail\" \\| \"exception\" \\| \"loading\" \\| \"none\" | 否 | - | - | icon值说明 success: 显示成功图标，error: 显示错误图标； fail: 显示错误图标，此时title文本无长度显示； exception: 显示异常图标，此时title文本无长度显示； loading: 显示加载图标；none: 不显示图标。 |\n@| image | [string.ImageURIString](/uts/data-type.md#ide-string) \\| null | 否 | - | - | 自定义图标的本地路径（app端暂不支持gif） |\n@| mask | boolean \\| null | 否 | - | - | 是否显示透明蒙层，防止触摸穿透，默认：false |\n@| duration | number \\| null | 否 | - | - | 提示的延迟时间，单位毫秒，默认：1500 |\n@| position | \"top\" \\| \"center\" \\| \"bottom\" | 否 | - | - | position值说明（仅App生效） top: 居上显示； center: 居中显示；bottom： 居底显示 |\n@| success | (res: ShowToastSuccess) => void \\| null | 否 | - | - | uni.showToast成功回调函数定义 |\n@| fail | (res: [IPromptError](#iprompterror-values)) => void \\| null | 否 | - | - | uni.showToast失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.showToast完成回调函数定义 | \n\n##### IPromptError 的属性值 @iprompterror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1 \\| 1001 | 是 | - | - | 错误码
- 1\t 撤销
- 1001 请求参数非法 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### showToast 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showtoast)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.prompt.showToast)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/toast/toast.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/toast/toast\n>Template\n```vue\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: 'toast',\n exeRet: ''\n }\n },\n onLoad() {\n uni.showToast({\n title: 'onLoad 调用示例,2秒后消失'\n })\n setTimeout(function () {\n uni.hideToast()\n }, 2000);\n },\n methods: {\n //自动化测试例专用\n jest_getWindowInfo() : GetWindowInfoResult {\n return uni.getWindowInfo();\n },\n toast1Tap: function () {\n uni.showToast({\n title: \"默认\",\n success: (res) => {\n this.exeRet = \"success:\" + JSON.stringify(res)\n },\n fail: (res) => {\n this.exeRet = \"fail:\" + JSON.stringify(res)\n },\n })\n },\n toastTapIconError: function () {\n uni.showToast({\n title: \"默认\",\n icon: 'error',\n success: (res) => {\n this.exeRet = \"success:\" + JSON.stringify(res)\n },\n fail: (res) => {\n this.exeRet = \"fail:\" + JSON.stringify(res)\n },\n })\n },\n toast2Tap: function () {\n uni.showToast({\n title: \"duration 3000\",\n duration: 3000,\n success: (res) => {\n this.exeRet = \"success:\" + JSON.stringify(res)\n },\n fail: (res) => {\n this.exeRet = \"fail:\" + JSON.stringify(res)\n },\n })\n },\n toast3Tap: function () {\n uni.showToast({\n title: \"loading\",\n icon: \"loading\",\n duration: 5000,\n success: (res) => {\n this.exeRet = \"success:\" + JSON.stringify(res)\n },\n fail: (res) => {\n this.exeRet = \"fail:\" + JSON.stringify(res)\n },\n })\n },\n toast4Tap: function () {\n uni.showToast({\n title: \"logo\",\n image: \"/static/uni.png\",\n success: (res) => {\n this.exeRet = \"success:\" + JSON.stringify(res)\n },\n fail: (res) => {\n this.exeRet = \"fail:\" + JSON.stringify(res)\n },\n })\n },\n // #ifdef APP\n toast5Tap: function () {\n uni.showToast({\n title: \"显示一段轻提示\",\n position: 'bottom',\n success: (res) => {\n this.exeRet = \"success:\" + JSON.stringify(res)\n },\n fail: (res) => {\n this.exeRet = \"fail:\" + JSON.stringify(res)\n },\n })\n },\n // #endif\n hideToast: function () {\n uni.hideToast()\n }\n }\n }\n\n```\n:::"},"loadFontFace":{"name":"## uni.loadFontFace(options) @loadfontface","description":"动态加载网络字体
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [LoadFontFaceOptions](#loadfontfaceoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| global | boolean | 否 | - | | 是否全局生效。微信小程序 '2.10.0'起支持全局生效，需在 app.vue 中调用。 |\n@| family | string | 是 | - | | 定义的字体名称 |\n@| source | string | 是 | - | | 字体资源的地址, App-Android 平台不支持 woff、woff2 格式字体文件 |\n@| desc | **LoadFontFaceOptionDesc** | 否 | - | | 可选的字体描述符 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| style | string \\| null | 否 | - | - | |\n@@| weight | string \\| null | 否 | - | - | |\n@@| variant | string \\| null | 否 | - | - | |\n@| success | (result: AsyncApiSuccessResult) => void | 否 | - | | 接口调用成功的回调函数 |\n@| fail | (error: [LoadFontFaceFail](#loadfontfacefail-values)) => void | 否 | - | | 接口调用失败的回调函数 |\n@| complete | (res: [AsyncApiResult](#asyncapiresult-values)) => void | 否 | - | | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### LoadFontFaceFail 的属性值 @loadfontfacefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 4 \\| 99 \\| 101 \\| 100001 \\| 100002 \\| 200001 \\| 300001 \\| 300002 | 是 | - | - | 错误码
- 4: 框架内部异常
- 99: page is not ready
- 101: 参数错误
- 100001: family is null
- 100002: source is null
- 200001: local font not found
- 300001: same source task is loading
- 300002: download fail |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n##### AsyncApiResult 的属性值 @asyncapiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Promise \\| null | 否 |\n \n","compatibility":"### loadFontFace 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | 4.10 | 4.0 |\n","tutorial":"\n### 参见\n- [loadFontFace](https://doc.dcloud.net.cn/uni-app-x/api/load-font-face.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.load-font-face)\n"},"load-font-face":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/load-font-face/load-font-face.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/load-font-face/load-font-face\n>Template\n```vue\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n uniIcon1: '\\ue100',\n uniIcon2: '\\ue101',\n }\n },\n onLoad() {\n uni.loadFontFace({\n global: true,\n family: 'UniFontFamily',\n source: \"url('/static/font/uni.ttf')\",\n success() {\n console.log('global loadFontFace uni.ttf success')\n },\n fail(error) {\n console.warn('global loadFontFace uni.ttf fail', error.errMsg)\n },\n })\n uni.loadFontFace({\n family: 'AlimamaDaoLiTiTTF',\n source:\n \"url('https://qiniu-web-assets.dcloud.net.cn/uni-app-x/static/font/AlimamaDaoLiTi.ttf')\",\n success() {\n console.log('loadFontFace Remote AlimamaDaoLiTi.ttf success')\n },\n fail(error) {\n console.warn('loadFontFace Remote AlimamaDaoLiTi.ttf fail', error.errMsg)\n },\n })\n uni.loadFontFace({\n family: 'AlimamaDaoLiTiOTF',\n source: \"url('/static/font/AlimamaDaoLiTi.otf')\",\n success() {\n console.log('loadFontFace AlimamaDaoLiTi.otf success')\n },\n fail(error) {\n console.warn('loadFontFace AlimamaDaoLiTi.otf fail', error.errMsg)\n },\n })\n uni.loadFontFace({\n family: 'AlimamaDaoLiTiWOFF',\n source: \"url('/static/font/AlimamaDaoLiTi.woff')\",\n success() {\n console.log('loadFontFace AlimamaDaoLiTi.woff success')\n },\n fail(error) {\n console.warn('loadFontFace AlimamaDaoLiTi.woff fail', error.errMsg)\n },\n })\n uni.loadFontFace({\n family: 'AlimamaDaoLiTiWOFF2',\n source: \"url('/static/font/AlimamaDaoLiTi.woff2')\",\n success() {\n console.log('loadFontFace AlimamaDaoLiTi.woff2 success')\n },\n fail(error) {\n console.warn('loadFontFace AlimamaDaoLiTi.woff2 fail', error.errMsg)\n },\n })\n },\n methods: {\n navigateToChild() {\n uni.navigateTo({\n url: '/pages/API/load-font-face/load-font-face-child',\n })\n },\n },\n }\n\n```\n:::"},"rpx2px":{"name":"## uni.rpx2px(number) @rpx2px","description":"将rpx单位值转换成px","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| number | number | 是 | - | - | | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| number |\n \n","compatibility":"### rpx2px 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.02 | 4.11 | 4.02 |\n","tutorial":"\n### 参见\n- [rpx2px](https://doc.dcloud.net.cn/uni-app-x/api/rpx2px.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.rpx2px)\n","example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/rpx2px/rpx2px.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/rpx2px/rpx2px\n>Template\n```vue\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: 'rpx2px',\n rpxValue: 750,\n pxValue: 0,\n result: false\n }\n },\n methods: {\n rpx2px: function () {\n this.pxValue = uni.rpx2px(this.rpxValue);\n\n // 仅限自动化测试\n const windowInfo = uni.getWindowInfo();\n if (windowInfo.windowWidth == this.pxValue) {\n this.result = true\n }\n }\n }\n }\n\n```\n:::"},"setAppTheme":{"name":"## uni.setAppTheme(options) @setapptheme","description":"设置应用主题","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SetAppThemeOptions](#setappthemeoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| theme | \"light\" \\| \"dark\" \\| \"auto\" | 是 | - | - | 主题 |\n@| success | (result: SetAppThemeSuccessResult) => void | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [IAppThemeFail](#iappthemefail-values)) => void | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### IAppThemeFail 的属性值 @iappthemefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 702001 \\| 2002000 | 是 | - | - | 错误码
- 702001 参数错误
- 2002000 未知错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### setAppTheme 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | 4.18 | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.theme.setAppTheme)\n"},"onOsThemeChange":{"name":"## uni.onOsThemeChange(callback) @onosthemechange","description":"开启监听系统主题变化","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: [OsThemeChangeResult](#osthemechangeresult-values)) => void | 是 | - | - | | \n\n#### OsThemeChangeResult 的属性值 @osthemechangeresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| osTheme | string | 是 | - | - | 系统主题 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| number |\n \n","compatibility":"### onOsThemeChange 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | 4.18 | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.theme.onOsThemeChange)\n"},"offOsThemeChange":{"name":"## uni.offOsThemeChange(id) @offosthemechange","description":"取消监听系统主题变化","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| id | number | 是 | - | - | | \n","returnValue":"","compatibility":"### offOsThemeChange 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | 4.18 | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.theme.offOsThemeChange)\n"},"onAppThemeChange":{"name":"## uni.onAppThemeChange(callback) @onappthemechange","description":"开启监听应用主题变化","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: [AppThemeChangeResult](#appthemechangeresult-values)) => void | 是 | - | - | | \n\n#### AppThemeChangeResult 的属性值 @appthemechangeresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| appTheme | string | 是 | - | - | 应用主题 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| number |\n \n","compatibility":"### onAppThemeChange 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | 4.18 | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.theme.onAppThemeChange)\n"},"offAppThemeChange":{"name":"## uni.offAppThemeChange(id) @offappthemechange","description":"取消监听应用主题变化","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| id | number | 是 | - | - | | \n","returnValue":"","compatibility":"### offAppThemeChange 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | 4.18 | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.theme.offAppThemeChange)\n"},"request":{"name":"## uni.request(param) @request","description":"发起网络请求。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| param | [RequestOptions\\](#requestoptions-values) | 是 | - | - | 网络请求参数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| url | string | 是 | - | | 开发者服务器接口地址
|\n@| data | any \\| null | 否 | null | | 请求的参数 UTSJSONObject\\|string类型 |\n@| header | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \\| null | 否 | null | | 设置请求的 header，header 中不能设置 Referer |\n@| method | \"GET\" \\| \"POST\" \\| \"PUT\" \\| \"PATCH\" \\| \"DELETE\" \\| \"HEAD\" \\| \"OPTIONS\" | 否 | \"GET\" | | 请求方法
- GET GET方法请求一个指定资源的表示形式，使用 GET 的请求应该只被用于获取数据。
- POST POST方法用于将实体提交到指定的资源，通常导致在服务器上的状态变化或副作用。
- PUT PUT方法用有效载荷请求替换目标资源的所有当前表示。
- PATCH PATCH方法用于对资源应用部分修改。
- DELETE DELETE方法删除指定的资源。
- HEAD HEAD方法请求一个与GET请求的响应相同的响应，但没有响应体。
- OPTIONS OPTIONS 方法用于描述目标资源的通信选项。 |\n@| timeout | number \\| null | 否 | 60000 | | 超时时间，单位 ms |\n@| withCredentials | boolean \\| null | 否 | - | | 跨域请求时是否携带凭证（cookies）
|\n@| success | (option: [RequestSuccess\\](#requestsuccess-values)) => void \\| null | 否 | null | - | 网络请求成功回调。 |\n@| fail | (option: [RequestFail](#requestfail-values)) => void \\| null | 否 | null | - | 网络请求失败回调。 |\n@| complete | (option: any) => void \\| null | 否 | null | - | 网络请求完成回调，成功或者失败都会调用。 | \n\n##### RequestSuccess\\ 的属性值 @requestsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | T \\| null | 否 | - | | 开发者服务器返回的数据 |\n| statusCode | number | 是 | - | | 开发者服务器返回的 HTTP 状态码 |\n| header | any | 是 | - | | 开发者服务器返回的 HTTP Response Header |\n| cookies | Array\\ | 是 | - | | 开发者服务器返回的 cookies，格式为字符串数组 |\n\n##### RequestFail 的属性值 @requestfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 5 \\| 1000 \\| 100001 \\| 100002 \\| 600003 \\| 600009 \\| 602001 | 是 | - | - | 错误码
- 5 接口超时
- 1000 服务端系统错误
- 100001 json数据解析错误
- 100002 错误信息json解析失败
- 600003 网络中断
- 600009 URL格式不合法
- 602001 request系统错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [RequestTask](#requesttask-values) |\n\n#### RequestTask 的方法 @requesttask-values \n\n#### abort() @abort\n中断网络请求。\n\n\n##### abort 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/request.html#request)\n \n","compatibility":"### request 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/request.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.request)\n","example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/request/request.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/request/request\n>Template\n```vue\n\r\n\r\n\n```\n>Script\n```uts\n\n // #ifdef APP\n import {\n testInovkeRequest,\n CommonOptions\n } from '@/uni_modules/test-invoke-network-api'\n // #endif\n\n class GETDataType {\n data: UTSJSONObject | null = null\n }\n\r\n const duration = 2000\r\n const methodMap = {\r\n \"GET\": \"/api/http/method/get\",\r\n \"POST\": \"/api/http/method/post\",\r\n \"PUT\": \"/api/http/method/put\",\r\n \"DELETE\": \"/api/http/method/delete\",\r\n \"PATCH\": \"/api/http/method/patch\",\r\n \"OPTIONS\": \"/api/http/method/options\",\r\n \"HEAD\": \"/api/http/method/head\"\r\n }\r\n\r\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'request',\r\n res: '',\r\n task: null as RequestTask | null,\r\n host: \"https://request.dcloud.net.cn\",\r\n url: \"/api/http/method/get\",\r\n method: \"GET\" as RequestMethod | null,\r\n data: null as any | null,\r\n header: null as UTSJSONObject | null,\r\n errorCodeUrls: [\r\n \"/api/http/statusCode/200\",\r\n \"/api/http/statusCode/204\",\r\n \"/api/http/statusCode/301\",\r\n \"/api/http/statusCode/302\",\r\n \"/api/http/statusCode/307\",\r\n \"/api/http/statusCode/400\",\r\n \"/api/http/statusCode/401\",\r\n \"/api/http/statusCode/403\",\r\n \"/api/http/statusCode/404\",\r\n \"/api/http/statusCode/405\",\r\n \"/api/http/statusCode/500\",\r\n \"/api/http/statusCode/502\",\r\n \"/api/http/statusCode/503\",\r\n \"/api/http/statusCode/504\",\r\n ],\r\n headerUrls: [\r\n \"/api/http/header/ua\",\r\n \"/api/http/header/referer\",\r\n \"/api/http/header/requestCookie\",\r\n \"/api/http/header/setCookie\",\r\n \"/api/http/header/deleteCookie\"\r\n ],\r\n contentTypeUrls: [\r\n \"/api/http/contentType/text/plain\",\r\n \"/api/http/contentType/text/html\",\r\n \"/api/http/contentType/text/xml\",\r\n \"/api/http/contentType/image/gif\",\r\n \"/api/http/contentType/image/jpeg\",\r\n \"/api/http/contentType/image/png\",\r\n \"/api/http/contentType/application/json\",\r\n \"/api/http/contentType/application/octetStream\",\r\n ],\r\n postUrls: [\r\n \"/api/http/contentType/json\",\r\n \"/api/http/contentType/xWwwFormUrlencoded\",\r\n ],\r\n //自动化测试例专用\r\n jest_result: false\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload() {\r\n uni.hideLoading();\r\n this.task?.abort();\r\n },\r\n methods: {\r\n changeMethod(e : RequestMethod) {\r\n this.method = e;\r\n this.url = methodMap[e] as string;\r\n this.data = null;\r\n this.header = null;\r\n },\r\n changeUrl(e : string) {\r\n this.method = \"GET\";\r\n this.url = e;\r\n this.data = null;\r\n this.header = null;\r\n },\r\n changeUrlFromPost(e : string) {\r\n this.method = \"POST\";\r\n this.url = e;\r\n switch (e) {\r\n case \"/api/http/contentType/json\":\r\n this.header = {\r\n \"Content-Type\": \"application/json\"\r\n };\r\n this.data = {\r\n \"hello\": \"world\"\r\n };\r\n break;\r\n case \"/api/http/contentType/xWwwFormUrlencoded\":\r\n this.header = {\r\n \"Content-Type\": \"application/x-www-form-urlencoded\"\r\n };\r\n this.data = \"hello=world\";\r\n break;\r\n }\r\n },\r\n sendRequest() {\r\n uni.showLoading({\r\n title: \"请求中...\"\r\n })\r\n this.task = uni.request({\r\n url: this.host + this.url,\r\n // dataType: \"json\",\r\n // responseType: \"json\",\r\n method: this.method,\r\n data: this.data,\r\n header: this.header,\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: (res) => {\r\n console.log('request success', JSON.stringify(res.data))\r\n console.log('request success header is :', JSON.stringify(res.header))\r\n uni.showToast({\r\n title: '请求成功',\r\n icon: 'success',\r\n mask: true,\r\n duration: duration\r\n });\r\n this.res = '请求结果 : ' + JSON.stringify(res);\r\n },\r\n fail: (err) => {\r\n console.log('request fail', err);\r\n uni.showModal({\r\n content: err.errMsg,\r\n showCancel: false\r\n });\r\n },\r\n complete: () => {\r\n uni.hideLoading()\r\n },\r\n });\r\n },\r\n //自动化测试例专用\r\n jest_request() {\r\n uni.request({\r\n url: this.host + this.url,\r\n // dataType: \"json\",\r\n // responseType: \"json\",\r\n method: this.method,\r\n data: this.data,\r\n header: this.header,\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_result = true;\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_set_cookie() {\r\n uni.request({\r\n url: this.host + \"/api/http/header/setCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_cookie_request(true)\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_delete_cookie() {\r\n uni.request({\r\n url: this.host + \"/api/http/header/deleteCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_cookie_request(false)\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_cookie_request(needCookie : boolean) {\r\n uni.request({\r\n url: this.host + \"/api/http/header/requestCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: (res) => {\n const requestCookie = (res.data as UTSJSONObject).getJSON(\"data\")?.getAny(\"requestCookie\")\r\n console.log(\"requestCookie \", requestCookie);\r\n if (requestCookie instanceof Array) {\r\n this.jest_result = needCookie ? requestCookie.length > 0 : requestCookie.length == 0\r\n } else {\r\n this.jest_result = needCookie ? (requestCookie as UTSJSONObject).toMap().size > 0 : (requestCookie as UTSJSONObject).toMap().size == 0\r\n }\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_timeout_null() {\r\n uni.request({\r\n url: this.host + (methodMap['GET'] as string),\r\n method: \"GET\",\r\n timeout: null,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\n this.jest_result = true;\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\n jest_get_with_data() {\n uni.request({\n url: \"https://unidemo.dcloud.net.cn/api/banner/36kr\",\n method: \"GET\",\n data:{\n column: 'id,post_id,title,author_name,cover,published_at' //需要的字段名\n },\n timeout: 6000,\n sslVerify: false,\n withCredentials: false,\n firstIpv4: false,\n success: () => {\n this.jest_result = true;\n },\n fail: () => {\n this.jest_result = false;\n },\n });\n },\n jest_get_with_generics() {\n uni.request({\n url: this.host + (methodMap['GET'] as string),\n method: \"GET\",\n timeout: null,\n sslVerify: false,\n withCredentials: false,\n firstIpv4: false,\n success: (res: RequestSuccess) => {\n console.log(\"success :\", res.data?.data);\n this.jest_result = true;\n },\n fail: () => {\n this.jest_result = false;\n },\n });\n },\n jest_get_array() {\n uni.request({\n url: 'https://unidemo.dcloud.net.cn/api/news?column=title,author_name,cover,published_at',\n method: \"GET\",\n success: (res : RequestSuccess) => {\n console.log(res)\n if (res.statusCode == 200 && Array.isArray(res.data)) {\n this.jest_result = true\n } else {\n this.jest_result = false\n }\n },\n fail: () => {\n this.jest_result = false\n }\n });\n },\n jest_uts_module_invoked(){\n // #ifdef APP\n testInovkeRequest({\n success:(res: any)=>{\n console.log(\"success :\", res);\n this.jest_result = true\n },\n fail:(err: any)=>{\n console.log(\"fail :\", err);\n this.jest_result = false\n }\n } as CommonOptions)\n // #endif\n }\r\n }\r\n }\r\n\n```\n:::"},"uploadFile":{"name":"## uni.uploadFile(options) @uploadfile","description":"将本地资源上传到开发者服务器。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [UploadFileOptions](#uploadfileoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| url | string | 是 | - | | 开发者服务器 url |\n@| filePath | string \\| null | 否 | null | | 要上传文件资源的路径, 支持uni.env |\n@| name | string \\| null | 否 | null | | 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容 |\n@| files | Array\\<**UploadFileOptionFiles**\\> \\| null | 否 | null | | 需要上传的文件列表。 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| name | string \\| null | 否 | \"file\" | | multipart 提交时，表单的项目名，默认为 file，如果 name 不填或填的值相同，可能导致服务端读取文件时只能读取到一个文件。 |\n@@| uri | string | 是 | - | | 要上传文件资源的路径 |\n@@| file | any \\| null | 否 | - | | 要上传的文件对象 |\n@| header | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \\| null | 否 | null | | HTTP 请求 Header, header 中不能设置 Referer |\n@| formData | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \\| null | 否 | null | | HTTP 请求中其他额外的 form data |\n@| timeout | number \\| null | 否 | 120000 | | 超时时间，单位 ms |\n@| success | (result: [UploadFileSuccess](#uploadfilesuccess-values)) => void \\| null | 否 | null | - | 成功返回的回调函数 |\n@| fail | (result: [UploadFileFail](#uploadfilefail-values)) => void \\| null | 否 | null | - | 失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 结束的回调函数（调用成功、失败都会执行） | \n\n##### UploadFileSuccess 的属性值 @uploadfilesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | string | 是 | - | | 开发者服务器返回的数据 |\n| statusCode | number | 是 | - | | 开发者服务器返回的 HTTP 状态码 |\n\n##### UploadFileFail 的属性值 @uploadfilefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 5 \\| 1000 \\| 100001 \\| 100002 \\| 600003 \\| 600009 \\| 602001 | 是 | - | - | 错误码
- 5 接口超时
- 1000 服务端系统错误
- 100001 json数据解析错误
- 100002 错误信息json解析失败
- 600003 网络中断
- 600009 URL格式不合法
- 602001 request系统错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [UploadTask](#uploadtask-values) |\n\n#### UploadTask 的方法 @uploadtask-values \n\n#### abort() @abort\n中断上传任务。\n\n\n##### abort 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/network-file.html#uploadfile)\n\n#### onProgressUpdate(callback) @onprogressupdate\n监听上传进度变化。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [OnProgressUpdateResult](#onprogressupdateresult-values)) => void | 是 | - | - | | \n\n##### OnProgressUpdateResult 的属性值 @onprogressupdateresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| progress | number | 是 | - | | 上传进度百分比 |\n| totalBytesSent | number | 是 | - | | 已经上传的数据长度，单位 Bytes |\n| totalBytesExpectedToSend | number | 是 | - | | 预期需要上传的数据总长度，单位 Bytes |\n\n\n##### onProgressUpdate 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/network-file.html#uploadfile)\n \n","compatibility":"### uploadFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/network-file.html#uploadfile)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.upload-file)\n"},"upload-file":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/upload-file/upload-file.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/upload-file/upload-file\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\n // #ifdef APP\n import {\n testInovkeUploadFile,\n CommonOptions\n } from '@/uni_modules/test-invoke-network-api'\n // #endif\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'uploadFile',\r\n imageSrc: '',\r\n task: null as UploadTask | null,\r\n //自动化测试例专用\r\n jest_result: false,\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload() {\r\n this.imageSrc = '';\r\n uni.hideLoading();\r\n this.task?.abort();\r\n },\r\n methods: {\r\n chooseImage: function () {\r\n uni.chooseImage({\r\n count: 1,\r\n sizeType: ['compressed'],\r\n sourceType: ['album'],\r\n success: (res) => {\r\n console.log('chooseImage success, temp path is', res.tempFilePaths[0])\r\n var imageSrc = res.tempFilePaths[0]\r\n uni.showLoading({\r\n title: '上传中'\r\n })\r\n this.task = uni.uploadFile({\r\n url: 'https://unidemo.dcloud.net.cn/upload', //仅为示例，非真实的接口地址\r\n filePath: imageSrc,\r\n name: 'file',\r\n formData: {\r\n 'user': 'test'\r\n },\r\n success: (res) => {\r\n console.log('uploadImage success, res is:', res)\r\n uni.hideLoading();\r\n uni.showToast({\r\n title: '上传成功',\r\n icon: 'success',\r\n duration: 1000\r\n })\r\n this.imageSrc = imageSrc\r\n },\r\n fail: (err) => {\r\n console.log('uploadImage fail', err);\r\n uni.hideLoading();\r\n uni.showModal({\r\n content: err.errMsg,\r\n showCancel: false\r\n });\r\n },\r\n });\r\n },\r\n fail: (err) => {\r\n console.log('chooseImage fail', err)\r\n }\r\n })\r\n },\r\n //自动化测试例专用\r\n jest_uploadFile() {\r\n const imageSrc = \"/static/uni.png\";\r\n this.task = uni.uploadFile({\r\n url: 'https://unidemo.dcloud.net.cn/upload', //仅为示例，非真实的接口地址\r\n filePath: imageSrc,\r\n name: 'file',\r\n formData: {\r\n 'user': 'test'\r\n },\r\n success: () => {\r\n this.jest_result = true;\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n })\r\n },\r\n jest_set_cookie() {\r\n uni.request({\r\n url: \"https://request.dcloud.net.cn/api/http/header/setCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_cookie_upload(true)\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n\r\n jest_delete_cookie() {\r\n uni.request({\r\n url: \"https://request.dcloud.net.cn/api/http/header/deleteCookie\",\r\n method: \"GET\",\r\n timeout: 6000,\r\n sslVerify: false,\r\n withCredentials: false,\r\n firstIpv4: false,\r\n success: () => {\r\n this.jest_cookie_upload(false)\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n });\r\n },\r\n jest_cookie_upload(needCookie : boolean) {\r\n const imageSrc = \"/static/uni.png\";\r\n this.task = uni.uploadFile({\r\n url: 'https://request.dcloud.net.cn/api/http/header/upload',\r\n filePath: imageSrc,\r\n name: 'file',\r\n success: (res : UploadFileSuccess) => {\r\n const data = JSON.parseObject(res.data)\r\n const errCode = data?.getNumber(\"errCode\")\r\n if (errCode != null && errCode == 1000) {\r\n this.jest_result = needCookie ? false : true;\r\n } else {\r\n this.jest_result = needCookie ? true : false;\r\n }\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n })\r\n },\r\n jest_files_upload() {\r\n const imageSrc = \"/static/uni.png\";\r\n this.task = uni.uploadFile({\r\n url: 'https://unidemo.dcloud.net.cn/upload',\r\n files: [\r\n {\r\n name: \"file1\",\r\n uri: imageSrc\r\n } as UploadFileOptionFiles,\r\n {\r\n name: \"file2\",\r\n uri: imageSrc\r\n } as UploadFileOptionFiles\r\n ],\r\n success: (res : UploadFileSuccess) => {\r\n if (res.statusCode == 200) {\r\n this.jest_result = true;\r\n }\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n },\r\n })\r\n },\n jest_uts_module_invoked(){\n // #ifdef APP\n testInovkeUploadFile({\n success:(res: any)=>{\n console.log(\"success :\", res);\n this.jest_result = true\n },\n fail:(err: any)=>{\n console.log(\"fail :\", err);\n this.jest_result = false\n }\n } as CommonOptions)\n // #endif\n }\r\n }\r\n }\r\n\n```\n:::"},"downloadFile":{"name":"## uni.downloadFile(options) @downloadfile","description":"下载文件资源到本地，客户端直接发起一个 HTTP GET 请求，返回文件的本地临时路径。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [DownloadFileOptions](#downloadfileoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| url | string | 是 | - | | 下载资源的 url |\n@| header | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \\| null | 否 | null | | HTTP 请求 Header，header 中不能设置 Referer |\n@| filePath | string \\| null | 否 | null | | 指定文件下载路径
支持相对路径与绝对路径，例：
`/imgs/pic.png`、`/storage/emulated/0/Android/data/io.dcloud.HBuilder/apps/HBuilder/temp/imgs/pic.png`
并且支持指定下载目录，例：
`/imgs/`
支持uni.env的平台兼容性：Android自3.9开始支持uni.env，iOS自4.13开始支持uni.env |\n@| timeout | number \\| null | 否 | 120000 | | 超时时间，单位 ms |\n@| success | (result: [DownloadFileSuccess](#downloadfilesuccess-values)) => void \\| null | 否 | null | - | 下载成功后以 tempFilePath 的形式传给页面，res = {tempFilePath: '文件的临时路径'} |\n@| fail | (result: [DownloadFileFail](#downloadfilefail-values)) => void \\| null | 否 | null | - | 失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 结束的回调函数（调用成功、失败都会执行） | \n\n##### DownloadFileSuccess 的属性值 @downloadfilesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tempFilePath | string | 是 | - | | 临时文件路径，下载后的文件会存储到一个临时文件 |\n| statusCode | number | 是 | - | | 开发者服务器返回的 HTTP 状态码 |\n\n##### DownloadFileFail 的属性值 @downloadfilefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 5 \\| 1000 \\| 100001 \\| 100002 \\| 600003 \\| 600009 \\| 602001 | 是 | - | - | 错误码
- 5 接口超时
- 1000 服务端系统错误
- 100001 json数据解析错误
- 100002 错误信息json解析失败
- 600003 网络中断
- 600009 URL格式不合法
- 602001 request系统错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [DownloadTask](#downloadtask-values) |\n\n#### DownloadTask 的方法 @downloadtask-values \n\n#### abort() @abort\n中断下载任务。\n\n\n##### abort 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/network-file.html#downloadfile)\n\n#### onProgressUpdate(callback) @onprogressupdate\n监听下载进度变化。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [OnProgressDownloadResult](#onprogressdownloadresult-values)) => void | 是 | - | - | | \n\n##### OnProgressDownloadResult 的属性值 @onprogressdownloadresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| progress | number | 是 | - | | 下载进度百分比 |\n| totalBytesWritten | number | 是 | - | | 已经下载的数据长度，单位 Bytes |\n| totalBytesExpectedToWrite | number | 是 | - | | 预期需要下载的数据总长度，单位 Bytes |\n\n\n##### onProgressUpdate 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/network-file.html#downloadfile)\n \n","compatibility":"### downloadFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/network-file.html#downloadfile)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.download-file)\n"},"download-file":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/download-file/download-file.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/download-file/download-file\n>Template\n```vue\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\n\n // #ifdef APP\n import {\n testInovkeDownloadFile,\n CommonOptions\n } from '@/uni_modules/test-invoke-network-api'\n // #endif\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'downloadFile',\r\n imageSrc: '',\r\n task: null as DownloadTask | null,\r\n //自动化测试例专用\r\n jest_result: false\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload() {\r\n // this.imageSrc = '';\r\n uni.hideLoading();\r\n this.task?.abort();\r\n },\r\n methods: {\r\n downloadImage: function () {\r\n uni.showLoading({\r\n title: '下载中'\r\n })\r\n var self = this\r\n this.task = uni.downloadFile({\r\n url: \"https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni-app.png\",\r\n success: (res) => {\r\n console.log('downloadFile success, res is', res.tempFilePath)\r\n self.imageSrc = res.tempFilePath;\r\n uni.hideLoading();\r\n },\r\n fail: (err) => {\r\n console.log('downloadFile fail, err is:', err)\r\n uni.hideLoading();\r\n }\r\n });\r\n this.task?.onProgressUpdate((update) => {\r\n console.log(\"progress : \", update.progress);\r\n })\r\n },\r\n //自动化测试例专用\r\n jest_downloadFile() {\r\n uni.downloadFile({\r\n url: \"https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni-app.png\",\r\n success: () => {\r\n this.jest_result = true\r\n },\r\n fail: () => {\r\n this.jest_result = false\r\n }\r\n });\r\n },\n\n jest_downloadFile_with_uni_env() {\n uni.downloadFile({\n url: \"https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni-app.png\",\n filePath: `${uni.env.CACHE_PATH}/a/b/`,\n success: () => {\n this.jest_result = true\n },\n fail: () => {\n this.jest_result = false\n }\n });\n },\n\n jest_set_cookie(){\n uni.request({\n url: \"https://request.dcloud.net.cn/api/http/header/setCookie\",\n method: \"GET\",\n timeout: 6000,\n sslVerify: false,\n withCredentials: true,\n firstIpv4: false,\n success: () => {\n this.jest_cookie_download(true)\n },\n fail: () => {\n this.jest_result = false;\n },\n });\n },\n\n jest_delete_cookie(){\n uni.request({\n url: \"https://request.dcloud.net.cn/api/http/header/deleteCookie\",\n method: \"GET\",\n timeout: 6000,\n sslVerify: false,\n withCredentials: true,\n firstIpv4: false,\n success: () => {\n this.jest_cookie_download(false)\n },\n fail: () => {\n this.jest_result = false;\n },\n });\n },\n jest_cookie_download(needCookie: boolean){\n uni.downloadFile({\n url: \"https://request.dcloud.net.cn/api/http/header/download\",\n success: () => {\n this.jest_result = needCookie ? true : false;\n },\n fail: () => {\n this.jest_result = needCookie ? false : true;\n }\n });\n },\n jest_uts_module_invoked(){\n // #ifdef APP\n testInovkeDownloadFile({\n success:(res: any)=>{\n console.log(\"success :\", res);\n this.jest_result = true\n },\n fail:(err: any)=>{\n console.log(\"fail :\", err);\n this.jest_result = false\n }\n } as CommonOptions)\n // #endif\n },\n jest_special_characters_download(){\n uni.downloadFile({\n url: \"https://web-ext-storage.dcloud.net.cn/hello-uni-app-x/1789834995055525889-你好%23你好.png\",\n success: (res: DownloadFileSuccess) => {\n this.jest_result = true;\n console.log(\"res :\", res);\n },\n fail: () => {\n this.jest_result = false;\n }\n });\n }\r\n }\r\n }\r\n\n```\n:::"},"getNetworkType":{"name":"## uni.getNetworkType(options) @getnetworktype","description":"获取网络类型","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetNetworkTypeOptions](#getnetworktypeoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (result: [GetNetworkTypeSuccess](#getnetworktypesuccess-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetNetworkTypeSuccess 的属性值 @getnetworktypesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| networkType | string | 是 | - | - | 网络类型 |\n","returnValue":"","compatibility":"### getNetworkType 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/system/network?id=getnetworktype)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.get-network-type)\n"},"get-network-type":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-network-type/get-network-type.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-network-type/get-network-type\n>Template\n```vue\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'getNetworkType',\r\n hasNetworkType: false,\r\n networkType: '',\r\n connectedWifi: '',\r\n //自动化测试例专用\r\n jest_result: false,\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload: function () {\r\n this.networkType = '';\r\n this.hasNetworkType = false;\r\n },\r\n methods: {\r\n getNetworkType: function () {\r\n uni.getNetworkType({\r\n success: (res) => {\r\n console.log(res)\r\n this.hasNetworkType = true;\r\n this.networkType = res.networkType\r\n },\r\n fail: () => {\r\n uni.showModal({\r\n content: '获取失败！',\r\n showCancel: false\r\n })\r\n }\r\n })\r\n },\r\n clear: function () {\r\n this.hasNetworkType = false;\r\n this.networkType = '';\r\n this.connectedWifi = '';\r\n },\r\n //自动化测试例专用\r\n jest_getNetworkType() {\r\n uni.getNetworkType({\r\n success: () => {\r\n this.jest_result = true;\r\n },\r\n fail: () => {\r\n this.jest_result = false;\r\n }\r\n })\r\n }\r\n }\r\n }\r\n\n```\n:::"},"connectSocket":{"name":"## connectSocket(options) @connectsocket","description":"创建一个 WebSocket 连接。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ConnectSocketOptions](#connectsocketoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| url | string | 是 | - | | 开发者服务器接口地址 |\n@| header | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \\| null | 否 | null | | 如果属性名存在，且类型为UTSJSONObject返回对应的结果，不存在返回null |\n@| protocols | Array\\ \\| null | 否 | null | | 子协议数组 |\n@| success | (result: [ConnectSocketSuccess](#connectsocketsuccess-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [ConnectSocketFail](#connectsocketfail-values)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### ConnectSocketSuccess 的属性值 @connectsocketsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n\n##### ConnectSocketFail 的属性值 @connectsocketfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | 错误码
- 600009 URL格式不合法 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [SocketTask](#sockettask-values) |\n\n#### SocketTask 的方法 @sockettask-values \n\n#### send(options) @send\n通过 WebSocket 连接发送数据\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SendSocketMessageOptions](#sendsocketmessageoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| data | any | 是 | - | | 需要发送的内容 |\n@| success | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [SendSocketMessageFail](#sendsocketmessagefail-values)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SendSocketMessageFail 的属性值 @sendsocketmessagefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 10001 \\| 10002 \\| 602001 | 是 | - | - | 错误码
- 10001 发送数据超限，发送队列不能超过16M大小。
- 10002 websocket未连接
- 602001 websocket系统错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n\n##### send 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-send)\n\n#### close(options) @close\n关闭 WebSocket 连接\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **CloseSocketOptions** | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| code | number \\| null | 否 | 1000 | | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。如果这个参数没有被指定，默认的取值是1000 （表示正常连接关闭） |\n@| reason | string \\| null | 否 | \"\" | | 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本（不是字符） |\n@| success | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### close 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-close)\n\n#### onOpen(callback) @onopen\n监听 WebSocket 连接打开事件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | **OnSocketOpenCallbackResult** | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| header | any | 是 | - | | 连接成功的 HTTP 响应 Header | \n\n\n##### onOpen 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-onopen)\n\n#### onClose(callback) @onclose\n监听 WebSocket 连接关闭事件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: any) => void | 是 | - | - | | \n\n\n##### onClose 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-onclose)\n\n#### onError(callback) @onerror\n监听 WebSocket 错误\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void | 是 | - | - | | \n\n\n##### onError 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-onerror)\n\n#### onMessage(callback) @onmessage\n监听 WebSocket 接受到服务器的消息事件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [OnSocketMessageCallbackResult](#onsocketmessagecallbackresult-values)) => void | 是 | - | - | | \n\n##### OnSocketMessageCallbackResult 的属性值 @onsocketmessagecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | any | 是 | - | | 服务器返回的消息 |\n\n\n##### onMessage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n##### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/socket-task.html#sockettask-onmessage)\n \n","compatibility":"### connectSocket 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/websocket.html#connectsocket)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.connectSocket)\n"},"onSocketOpen":{"name":"## onSocketOpen(options) @onsocketopen","description":"监听WebSocket连接打开事件。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | (result: [OnSocketOpenCallbackResult](#onsocketopencallbackresult-values)) => void | 是 | - | - | | \n","returnValue":"","compatibility":"### onSocketOpen 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketopen)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.onSocketOpen)\n"},"onSocketError":{"name":"## onSocketError(callback) @onsocketerror","description":"下载文件资源到本地，客户端直接发起一个 HTTP GET 请求，返回文件的本地临时路径。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [OnSocketErrorCallbackResult](#onsocketerrorcallbackresult-values)) => void | 是 | - | - | | \n\n#### OnSocketErrorCallbackResult 的属性值 @onsocketerrorcallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | 错误信息 |\n","returnValue":"","compatibility":"### onSocketError 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketerror)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.onSocketError)\n"},"sendSocketMessage":{"name":"## sendSocketMessage(options) @sendsocketmessage","description":"通过 WebSocket 连接发送数据，需要先 uni.connectSocket，并在 uni.onSocketOpen 回调之后才能发送。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SendSocketMessageOptions](#sendsocketmessageoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| data | any | 是 | - | | 需要发送的内容 |\n@| success | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [SendSocketMessageFail](#sendsocketmessagefail-values)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SendSocketMessageFail 的属性值 @sendsocketmessagefail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 10001 \\| 10002 \\| 602001 | 是 | - | - | 错误码
- 10001 发送数据超限，发送队列不能超过16M大小。
- 10002 websocket未连接
- 602001 websocket系统错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### sendSocketMessage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/websocket.html#sendsocketmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.sendSocketMessage)\n"},"onSocketMessage":{"name":"## onSocketMessage(callback) @onsocketmessage","description":"监听WebSocket接受到服务器的消息事件。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [OnSocketMessageCallbackResult](#onsocketmessagecallbackresult-values)) => void | 是 | - | - | | \n\n#### OnSocketMessageCallbackResult 的属性值 @onsocketmessagecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | any | 是 | - | | 服务器返回的消息 |\n","returnValue":"","compatibility":"### onSocketMessage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.onSocketMessage)\n"},"closeSocket":{"name":"## closeSocket(options) @closesocket","description":"关闭 WebSocket 连接。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **CloseSocketOptions** | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| code | number \\| null | 否 | 1000 | | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。如果这个参数没有被指定，默认的取值是1000 （表示正常连接关闭） |\n@| reason | string \\| null | 否 | \"\" | | 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本（不是字符） |\n@| success | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: [GeneralCallbackResult](#generalcallbackresult-values)) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n","returnValue":"","compatibility":"### closeSocket 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/websocket.html#closesocket)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.closeSocket)\n"},"onSocketClose":{"name":"## onSocketClose(callback) @onsocketclose","description":"监听WebSocket关闭。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [OnSocketCloseCallbackResult](#onsocketclosecallbackresult-values)) => void | 是 | - | - | | \n\n#### OnSocketCloseCallbackResult 的属性值 @onsocketclosecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| code | number | 是 | - | | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。 |\n| reason | string | 是 | - | | 一个可读的字符串，表示连接被关闭的原因。\t |\n","returnValue":"","compatibility":"### onSocketClose 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketclose)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.websocket-global.onSocketClose)\n"},"websocket-global":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/websocket-global/websocket-global.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/websocket-global/websocket-global\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n connected: false,\r\n connecting: false,\r\n msg: '',\r\n roomId: '',\r\n platform: '',\r\n }\r\n },\r\n computed: {\r\n showMsg() : string {\r\n if (this.connected) {\r\n if (this.msg.length > 0) {\r\n return '收到消息：' + this.msg\r\n } else {\r\n return '等待接收消息'\r\n }\r\n } else {\r\n return '尚未连接'\r\n }\r\n },\r\n },\r\n onLoad() {\r\n this.platform = uni.getSystemInfoSync().platform\r\n },\r\n onUnload() {\r\n uni.closeSocket({\r\n code: 1000,\r\n reason: 'close reason from client',\r\n success: (res : any) => {\r\n console.log('uni.closeSocket success', res)\r\n },\r\n fail: (err : any) => {\r\n console.log('uni.closeSocket fail', err)\r\n },\r\n } as CloseSocketOptions)\r\n uni.hideLoading()\r\n },\r\n methods: {\r\n connect() {\r\n if (this.connected || this.connecting) {\r\n uni.showModal({\r\n content: '正在连接或者已经连接，请勿重复连接',\r\n showCancel: false,\r\n })\r\n return\r\n }\r\n this.connecting = true\r\n uni.showLoading({\r\n title: '连接中...',\r\n })\r\n uni.connectSocket({\r\n url: 'ws://websocket.dcloud.net.cn',\r\n header: null,\r\n protocols: null,\r\n success: (res : any) => {\r\n // 这里是接口调用成功的回调，不是连接成功的回调，请注意\r\n console.log('uni.connectSocket success', res)\r\n },\r\n fail: (err : any) => {\r\n // 这里是接口调用失败的回调，不是连接失败的回调，请注意\r\n console.log('uni.connectSocket fail', err)\r\n },\r\n })\r\n uni.onSocketOpen((res) => {\r\n this.connecting = false\r\n this.connected = true\r\n uni.hideLoading()\r\n\r\n uni.showToast({\r\n icon: 'none',\r\n title: '连接成功',\r\n })\r\n console.log('onOpen', res)\r\n })\r\n uni.onSocketError((err) => {\r\n this.connecting = false\r\n this.connected = false\r\n uni.hideLoading()\r\n\r\n uni.showModal({\r\n content: '连接失败，可能是websocket服务不可用，请稍后再试',\r\n showCancel: false,\r\n })\r\n console.log('onError', err)\r\n })\r\n uni.onSocketMessage((res) => {\r\n this.msg = res.data as string\r\n console.log('onMessage', res)\r\n })\r\n uni.onSocketClose((res) => {\r\n this.connected = false\r\n this.msg = ''\r\n console.log('onClose', res)\r\n })\r\n },\r\n send() {\r\n uni.sendSocketMessage({\r\n data:\r\n 'from ' +\r\n this.platform +\r\n ' : ' +\r\n parseInt((Math.random() * 10000).toString()).toString(),\r\n success: (res : any) => {\r\n console.log(res)\r\n },\r\n fail: (err : any) => {\r\n console.log(err)\r\n },\r\n } as SendSocketMessageOptions)\r\n },\r\n close() {\r\n uni.closeSocket({\r\n code: 1000,\r\n reason: 'close reason from client',\r\n success: (res : any) => {\r\n console.log('uni.closeSocket success', res)\r\n },\r\n fail: (err : any) => {\r\n console.log('uni.closeSocket fail', err)\r\n },\r\n } as CloseSocketOptions)\r\n },\r\n },\r\n }\r\n\n```\n:::"},"getSystemInfo":{"name":"## uni.getSystemInfo(options) @getsysteminfo","description":"异步获取系统信息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetSystemInfoOptions](#getsysteminfooptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (result: [GetSystemInfoResult](#getsysteminforesult-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetSystemInfoResult 的属性值 @getsysteminforesult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| SDKVersion | string | 是 | - | | 客户端基础库版本
|\n| appId | string | 是 | - | | `manifest.json` 中应用appid。
|\n| appLanguage | string | 是 | - | | 应用设置的语言。
|\n| appName | string | 是 | - | | `manifest.json` 中应用名称。
|\n| appVersion | string | 是 | - | | `manifest.json` 中应用版本名称。
|\n| appVersionCode | string | 是 | - | | `manifest.json` 中应用版本名号。
|\n| ~~brand~~ | string | 是 | - | | 手机品牌。 **已废弃，仅为了向下兼容保留** |\n| browserName | string | 是 | - | | 浏览器名称。`App` 端是系统 webview 的名字，比如 wkwebview、chrome。小程序端为空
|\n| browserVersion | string | 是 | - | | 浏览器版本、webview 版本。
|\n| deviceId | string | 是 | - | | 设备 ID
|\n| deviceBrand | string | 是 | - | | 设备品牌。如：`apple`、`huawei`。
|\n| deviceModel | string | 是 | - | | 设备型号
|\n| deviceType | \"phone\" \\| \"pad\" \\| \"tv\" \\| \"watch\" \\| \"pc\" \\| \"undefined\" \\| \"car\" \\| \"vr\" \\| \"appliance\" | 是 | - | | 设备类型。
|\n| devicePixelRatio | number | 是 | - | | 设备像素比
|\n| deviceOrientation | \"portrait\" \\| \"landscape\" | 是 | - | | 设备方向。 |\n| ~~language~~ | string | 是 | - | | 程序设置的语言 **已废弃，仅为了向下兼容保留** |\n| ~~model~~ | string | 是 | - | | 手机型号 **已废弃，仅为了向下兼容保留** |\n| osName | \"ios\" \\| \"android\" \\| \"macos\" \\| \"windows\" \\| \"linux\" | 是 | - | | 系统名称\t
|\n| osVersion | string | 是 | - | | 操作系统版本。如 ios 版本，andriod 版本
|\n| osLanguage | string | 是 | - | | 操作系统语言
|\n| osTheme | \"light\" \\| \"dark\" | 否 | - | | 操作系统主题
|\n| ~~pixelRatio~~ | number | 是 | - | | 设备像素比 **已废弃，仅为了向下兼容保留** |\n| ~~platform~~ | \"ios\" \\| \"android\" \\| \"mac\" \\| \"windows\" \\| \"linux\" | 是 | - | | 客户端平台 **已废弃，仅为了向下兼容保留** |\n| screenWidth | number | 是 | - | | 屏幕宽度，单位为px
|\n| screenHeight | number | 是 | - | | 屏幕高度，单位为px
|\n| statusBarHeight | number | 是 | - | | 状态栏的高度，单位为px
|\n| ~~system~~ | string | 是 | - | | 操作系统版本 **已废弃，仅为了向下兼容保留** |\n| safeArea | **SafeArea** | 是 | - | | 在竖屏正方向下的安全区域
|\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| left | number | 是 | - | | 安全区域左上角横坐标，单位为px
|\n@| right | number | 是 | - | | 安全区域右下角横坐标，单位为px
|\n@| top | number | 是 | - | | 安全区域左上角纵坐标，单位为px
|\n@| bottom | number | 是 | - | | 安全区域右下角纵坐标，单位为px
|\n@| width | number | 是 | - | | 安全区域的宽度，单位为px
|\n@| height | number | 是 | - | | 安全区域的高度，单位为px
|\n| safeAreaInsets | **SafeAreaInsets** | 是 | - | | 在竖屏正方向下的安全区域插入位置
|\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| left | number | 是 | - | | 安全区域左侧插入位置，单位为px
|\n@| right | number | 是 | - | | 安全区域右侧插入位置，单位为px
|\n@| top | number | 是 | - | | 安全区顶部插入位置，单位为px
|\n@| bottom | number | 是 | - | | 安全区域底部插入位置，单位为px
|\n| ua | string | 是 | - | | 用户标识。小程序端为空
|\n| ~~uniCompileVersion~~ | string | 是 | - | | uni 编译器版本。 **已废弃，仅为了向下兼容保留** |\n| uniCompilerVersion | string | 是 | - | | uni 编译器版本。
|\n| uniPlatform | \"app\" \\| \"web\" \\| \"mp-weixin\" \\| \"mp-alipay\" \\| \"mp-baidu\" \\| \"mp-toutiao\" \\| \"mp-lark\" \\| \"mp-qq\" \\| \"mp-kuaishou\" \\| \"mp-jd\" \\| \"mp-360\" \\| \"quickapp-webview\" \\| \"quickapp-webview-union\" \\| \"quickapp-webview-huawei\" | 是 | - | | uni-app 运行平台，与条件编译平台相同。
|\n| uniRuntimeVersion | string | 是 | - | | uni 运行时版本。
|\n| ~~uniCompileVersionCode~~ | number | 是 | - | | uni 编译器版本号。 **已废弃，仅为了向下兼容保留** |\n| uniCompilerVersionCode | number | 是 | - | | uni 编译器版本号。
|\n| uniRuntimeVersionCode | number | 是 | - | | uni 运行时版本号。
|\n| ~~version~~ | string | 是 | - | | 引擎版本号。 **已废弃，仅为了向下兼容保留** |\n| romName | string | 是 | - | | rom 名称。Android 部分机型获取不到值。iOS 恒为 `ios`
|\n| romVersion | string | 是 | - | | rom 版本号。Android 部分机型获取不到值。iOS 为操作系统版本号（同 `osVersion`）。
|\n| windowWidth | number | 是 | - | | 可使用窗口宽度，单位为px
|\n| windowHeight | number | 是 | - | | 可使用窗口高度，单位为px
|\n| windowTop | number | 是 | - | | 内容区域距离顶部的距离（同CSS变量 `--window-top`），单位为px
|\n| windowBottom | number | 是 | - | | 内容区域距离底部的距离（同CSS变量 `--window-bottom`），单位为px
|\n| osAndroidAPILevel | number \\| null | 否 | - | | Android 系统API库的版本。
|\n| appTheme | \"light\" \\| \"dark\" \\| \"auto\" | 否 | - | | 当前App的主题
|\n","returnValue":"","compatibility":"### getSystemInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/system/info?id=getsysteminfo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-system-info.getSystemInfo)\n"},"getSystemInfoSync":{"name":"## uni.getSystemInfoSync() @getsysteminfosync","description":"同步获取系统信息","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **GetSystemInfoResult** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| SDKVersion | string | 是 | - | | 客户端基础库版本
|\n@| appId | string | 是 | - | | `manifest.json` 中应用appid。
|\n@| appLanguage | string | 是 | - | | 应用设置的语言。
|\n@| appName | string | 是 | - | | `manifest.json` 中应用名称。
|\n@| appVersion | string | 是 | - | | `manifest.json` 中应用版本名称。
|\n@| appVersionCode | string | 是 | - | | `manifest.json` 中应用版本名号。
|\n@| ~~brand~~ | string | 是 | - | | 手机品牌。 **已废弃，仅为了向下兼容保留** |\n@| browserName | string | 是 | - | | 浏览器名称。`App` 端是系统 webview 的名字，比如 wkwebview、chrome。小程序端为空
|\n@| browserVersion | string | 是 | - | | 浏览器版本、webview 版本。
|\n@| deviceId | string | 是 | - | | 设备 ID
|\n@| deviceBrand | string | 是 | - | | 设备品牌。如：`apple`、`huawei`。
|\n@| deviceModel | string | 是 | - | | 设备型号
|\n@| deviceType | \"phone\" \\| \"pad\" \\| \"tv\" \\| \"watch\" \\| \"pc\" \\| \"null\" \\| \"car\" \\| \"vr\" \\| \"appliance\" | 是 | - | | 设备类型。
|\n@| devicePixelRatio | number | 是 | - | | 设备像素比
|\n@| deviceOrientation | \"portrait\" \\| \"landscape\" | 是 | - | | 设备方向。 |\n@| ~~language~~ | string | 是 | - | | 程序设置的语言 **已废弃，仅为了向下兼容保留** |\n@| ~~model~~ | string | 是 | - | | 手机型号 **已废弃，仅为了向下兼容保留** |\n@| osName | \"ios\" \\| \"android\" \\| \"macos\" \\| \"windows\" \\| \"linux\" | 是 | - | | 系统名称\t
|\n@| osVersion | string | 是 | - | | 操作系统版本。如 ios 版本，andriod 版本
|\n@| osLanguage | string | 是 | - | | 操作系统语言
|\n@| osTheme | \"light\" \\| \"dark\" | 否 | - | | 操作系统主题
|\n@| ~~pixelRatio~~ | number | 是 | - | | 设备像素比 **已废弃，仅为了向下兼容保留** |\n@| ~~platform~~ | \"ios\" \\| \"android\" \\| \"mac\" \\| \"windows\" \\| \"linux\" | 是 | - | | 客户端平台 **已废弃，仅为了向下兼容保留** |\n@| screenWidth | number | 是 | - | | 屏幕宽度，单位为px
|\n@| screenHeight | number | 是 | - | | 屏幕高度，单位为px
|\n@| statusBarHeight | number | 是 | - | | 状态栏的高度，单位为px
|\n@| ~~system~~ | string | 是 | - | | 操作系统版本 **已废弃，仅为了向下兼容保留** |\n@| safeArea | **SafeArea** | 是 | - | | 在竖屏正方向下的安全区域
|\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| left | number | 是 | - | | 安全区域左上角横坐标，单位为px
|\n@@| right | number | 是 | - | | 安全区域右下角横坐标，单位为px
|\n@@| top | number | 是 | - | | 安全区域左上角纵坐标，单位为px
|\n@@| bottom | number | 是 | - | | 安全区域右下角纵坐标，单位为px
|\n@@| width | number | 是 | - | | 安全区域的宽度，单位为px
|\n@@| height | number | 是 | - | | 安全区域的高度，单位为px
|\n@| safeAreaInsets | **SafeAreaInsets** | 是 | - | | 在竖屏正方向下的安全区域插入位置
|\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| left | number | 是 | - | | 安全区域左侧插入位置，单位为px
|\n@@| right | number | 是 | - | | 安全区域右侧插入位置，单位为px
|\n@@| top | number | 是 | - | | 安全区顶部插入位置，单位为px
|\n@@| bottom | number | 是 | - | | 安全区域底部插入位置，单位为px
|\n@| ua | string | 是 | - | | 用户标识。小程序端为空
|\n@| ~~uniCompileVersion~~ | string | 是 | - | | uni 编译器版本。 **已废弃，仅为了向下兼容保留** |\n@| uniCompilerVersion | string | 是 | - | | uni 编译器版本。
|\n@| uniPlatform | \"app\" \\| \"web\" \\| \"mp-weixin\" \\| \"mp-alipay\" \\| \"mp-baidu\" \\| \"mp-toutiao\" \\| \"mp-lark\" \\| \"mp-qq\" \\| \"mp-kuaishou\" \\| \"mp-jd\" \\| \"mp-360\" \\| \"quickapp-webview\" \\| \"quickapp-webview-union\" \\| \"quickapp-webview-huawei\" | 是 | - | | uni-app 运行平台，与条件编译平台相同。
|\n@| uniRuntimeVersion | string | 是 | - | | uni 运行时版本。
|\n@| ~~uniCompileVersionCode~~ | number | 是 | - | | uni 编译器版本号。 **已废弃，仅为了向下兼容保留** |\n@| uniCompilerVersionCode | number | 是 | - | | uni 编译器版本号。
|\n@| uniRuntimeVersionCode | number | 是 | - | | uni 运行时版本号。
|\n@| ~~version~~ | string | 是 | - | | 引擎版本号。 **已废弃，仅为了向下兼容保留** |\n@| romName | string | 是 | - | | rom 名称。Android 部分机型获取不到值。iOS 恒为 `ios`
|\n@| romVersion | string | 是 | - | | rom 版本号。Android 部分机型获取不到值。iOS 为操作系统版本号（同 `osVersion`）。
|\n@| windowWidth | number | 是 | - | | 可使用窗口宽度，单位为px
|\n@| windowHeight | number | 是 | - | | 可使用窗口高度，单位为px
|\n@| windowTop | number | 是 | - | | 内容区域距离顶部的距离（同CSS变量 `--window-top`），单位为px
|\n@| windowBottom | number | 是 | - | | 内容区域距离底部的距离（同CSS变量 `--window-bottom`），单位为px
|\n@| osAndroidAPILevel | number \\| null | 否 | - | | Android 系统API库的版本。
|\n@| appTheme | \"light\" \\| \"dark\" \\| \"auto\" | 否 | - | | 当前App的主题
| \n","compatibility":"### getSystemInfoSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/system/info?id=getsysteminfosync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-system-info.getSystemInfoSync)\n"},"get-system-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-system-info/get-system-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-system-info/get-system-info\n>Template\n```vue\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n type Item = {\r\n label : string,\r\n value : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'getSystemInfo',\r\n items: [] as Item[],\r\n }\r\n },\r\n onUnload: function () {\r\n },\r\n methods: {\r\n getSystemInfo: function () {\r\n uni.getSystemInfo({\r\n success: (res) => {\r\n this.items = [] as Item[];\n const res_str = JSON.stringify(res);\n const res_obj = JSON.parseObject(res_str);\n const res_map = res_obj!.toMap();\n let keys = [] as string[]\n res_map.forEach((_, key) => {\n keys.push(key);\n });\n keys.sort().forEach( key => {\n const value = res[key];\n if(value != null){\n const item = {\n \tlabel: key,\n \tvalue: \"\" + ((typeof value == \"object\")? JSON.stringify(value) : value)\n } as Item;\n this.items.push(item);\n }\n });\r\n },\r\n })\r\n },\r\n getSystemInfoSync: function () {\r\n this.items = [] as Item[];\r\n const res = uni.getSystemInfoSync()\n const res_str = JSON.stringify(res);\n const res_obj = JSON.parseObject(res_str);\n const res_map = res_obj!.toMap();\n let keys = [] as string[]\n res_map.forEach((_, key) => {\n keys.push(key);\n });\n keys.sort().forEach( key => {\n const value = res[key];\n if(value != null){\n const item = {\n \tlabel: key,\n \tvalue: \"\" + ((typeof value == \"object\")? JSON.stringify(value) : value)\n } as Item;\n this.items.push(item);\n }\n });\r\n },\r\n //自动化测试例专用\r\n jest_getSystemInfo() : GetSystemInfoResult {\r\n return uni.getSystemInfoSync();\r\n },\r\n }\r\n }\r\n\n```\n:::"},"getDeviceInfo":{"name":"## uni.getDeviceInfo(options?) @getdeviceinfo","description":"获取设备信息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **GetDeviceInfoOptions** | 否 | 包含所有字段的过滤对象 | - | \\[options=包含所有字段的过滤对象]过滤的字段对象, 不传参数默认为获取全部字段。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filter | Array\\ | 是 | - | - | 过滤字段的字符串数组，假如要获取指定字段，传入此数组。 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **GetDeviceInfoResult** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| ~~brand~~ | string | 否 | - | | 设备品牌 **已废弃，仅为了向下兼容保留** |\n@| deviceBrand | string | 否 | - | | 设备品牌
|\n@| deviceId | string | 否 | - | | 设备 id 。由 uni-app 框架生成并存储，清空 Storage 会导致改变
|\n@| ~~model~~ | string | 否 | - | | 设备型号\t **已废弃，仅为了向下兼容保留** |\n@| deviceModel | string | 否 | - | | 设备型号\t
|\n@| deviceType | string | 否 | - | | 设备类型phone、pad、pc\t
|\n@| deviceOrientation | string | 否 | - | | 设备方向 竖屏 portrait、横屏 landscape\t
|\n@| devicePixelRatio | string | 否 | - | | 设备像素比\t
|\n@| system | string | 否 | - | | 操作系统及版本\t
|\n@| platform | string | 否 | - | | 客户端平台\t
|\n@| isRoot | boolean | 否 | - | | 是否root
|\n@| isSimulator | boolean | 否 | - | | 是否是模拟器
|\n@| isUSBDebugging | boolean | 否 | - | | adb是否开启
|\n@| osName | \"ios\" \\| \"android\" \\| \"macos\" \\| \"windows\" \\| \"linux\" | 否 | - | | 系统名称\t
|\n@| osVersion | string \\| null | 否 | - | | 操作系统版本。如 ios 版本，andriod 版本
|\n@| osLanguage | string \\| null | 否 | - | | 操作系统语言
|\n@| osTheme | \"light\" \\| \"dark\" | 否 | - | | 操作系统主题
|\n@| osAndroidAPILevel | number \\| null | 否 | - | | Android 系统API库的版本。
|\n@| romName | string \\| null | 否 | - | | rom 名称。Android 部分机型获取不到值。iOS 恒为 `ios`
|\n@| romVersion | string \\| null | 否 | - | | rom 版本号。Android 部分机型获取不到值。iOS 为操作系统版本号（同 `osVersion`）。
| \n","compatibility":"### getDeviceInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/getDeviceInfo.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-device-info)\n"},"get-device-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-device-info/get-device-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-device-info/get-device-info\n>Template\n```vue\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { setDevicePixelRatio } from '@/store/index.uts'\r\n\r\n type Item = {\r\n label : string,\r\n value : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'getDeviceInfo',\r\n items: [] as Item[],\r\n }\r\n },\r\n onUnload: function () {\r\n },\r\n methods: {\r\n getDeviceInfo: function () {\r\n const res = uni.getDeviceInfo();\r\n // 获取像素比, 供截图对比使用\r\n setDevicePixelRatio(res.devicePixelRatio !== null ? parseFloat(res.devicePixelRatio!) : 1)\r\n this.items = [] as Item[];\n\n const res_str = JSON.stringify(res);\n const res_obj = JSON.parseObject(res_str);\n const res_map = res_obj!.toMap();\n let keys = [] as string[]\n res_map.forEach((_, key) => {\n keys.push(key);\n });\n keys.sort().forEach( key => {\n const value = res[key];\n if(value != null){\n const item = {\n \tlabel: key,\n \tvalue: \"\" + ((typeof value == \"object\")? JSON.stringify(value) : value)\n } as Item;\n this.items.push(item);\n }\n });\r\n }\r\n }\r\n }\r\n\n```\n:::"},"getWindowInfo":{"name":"## uni.getWindowInfo() @getwindowinfo","description":"同步获取窗口信息","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **GetWindowInfoResult** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pixelRatio | number | 是 | - | | 设备像素比
|\n@| screenWidth | number | 是 | - | | 屏幕宽度，单位为px
|\n@| screenHeight | number | 是 | - | | 屏幕高度，单位为px
|\n@| windowWidth | number | 是 | - | | 可使用窗口宽度，单位为px
|\n@| windowHeight | number | 是 | - | | 可使用窗口高度，单位为px
|\n@| statusBarHeight | number | 是 | - | | 状态栏的高度，单位为px
|\n@| windowTop | number | 是 | - | | 内容区域距离顶部的距离（同CSS变量 `--window-top`），单位为px
|\n@| windowBottom | number | 是 | - | | 内容区域距离底部的距离（同CSS变量 `--window-bottom`），单位为px
|\n@| safeArea | **SafeArea** | 是 | - | | 在竖屏正方向下的安全区域
|\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| left | number | 是 | - | | 安全区域左上角横坐标，单位为px
|\n@@| right | number | 是 | - | | 安全区域右下角横坐标，单位为px
|\n@@| top | number | 是 | - | | 安全区域左上角纵坐标，单位为px
|\n@@| bottom | number | 是 | - | | 安全区域右下角纵坐标，单位为px
|\n@@| width | number | 是 | - | | 安全区域的宽度，单位为px
|\n@@| height | number | 是 | - | | 安全区域的高度，单位为px
|\n@| safeAreaInsets | **SafeAreaInsets** | 是 | - | | 在竖屏正方向下的安全区域插入位置
|\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| left | number | 是 | - | | 安全区域左侧插入位置，单位为px
|\n@@| right | number | 是 | - | | 安全区域右侧插入位置，单位为px
|\n@@| top | number | 是 | - | | 安全区顶部插入位置，单位为px
|\n@@| bottom | number | 是 | - | | 安全区域底部插入位置，单位为px
|\n@| screenTop | number | 是 | - | | 窗口上边缘的 y 值，单位为px
| \n","compatibility":"### getWindowInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/system/getWindowInfo.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-window-info)\n"},"get-window-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-window-info/get-window-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-window-info/get-window-info\n>Template\n```vue\n\r\n\r\n\r\n\n\n```\n>Script\n```uts\n\r\n import { setStatusBarHeight, setSafeArea } from '@/store/index.uts'\r\n // #ifdef APP-ANDROID\r\n import type { SafeArea } from '@/store/index.uts'\r\n // #endif\r\n\r\n type Item = {\r\n label : string,\r\n value : string,\r\n }\r\n export default {\r\n data() {\r\n return {\r\n title: 'getWindowInfo',\r\n items: [] as Item[],\r\n }\r\n },\r\n onUnload: function () {\r\n },\r\n onReady() {\r\n this.getWindowInfo()\r\n },\r\n methods: {\r\n getWindowInfo: function () {\r\n const res = uni.getWindowInfo();\r\n // 获取状态栏高度, 供截图对比使用\r\n setStatusBarHeight(res.statusBarHeight);\r\n // 获取安全区信息,供截图使用\r\n // #ifdef APP-ANDROID\r\n setSafeArea({\r\n top: res.safeArea.top,\r\n left: res.safeArea.left,\r\n right: res.safeArea.right,\r\n bottom: res.safeArea.bottom,\r\n width: res.safeArea.width,\r\n height: res.safeArea.height,\r\n } as SafeArea);\r\n // #endif\r\n // #ifdef APP-IOS\r\n setSafeArea({\r\n top: res.safeArea.top,\r\n left: res.safeArea.left,\r\n right: res.safeArea.right,\r\n bottom: res.safeArea.bottom,\r\n width: res.safeArea.width,\r\n height: res.safeArea.height,\r\n });\r\n // #endif\r\n this.items = [] as Item[];\r\n\r\n const res_str = JSON.stringify(res);\r\n const res_obj = JSON.parseObject(res_str);\r\n const res_map = res_obj!.toMap();\r\n let keys = [] as string[]\r\n res_map.forEach((_, key) => {\r\n keys.push(key);\r\n });\r\n keys.sort().forEach(key => {\r\n const value = res[key];\r\n if (value != null) {\r\n const item = {\r\n label: key,\r\n value: \"\" + ((typeof value == \"object\") ? JSON.stringify(value) : value)\r\n } as Item;\r\n this.items.push(item);\r\n }\r\n });\r\n },\r\n //自动化测试例专用\r\n jest_getWindowInfo() : GetWindowInfoResult {\r\n return uni.getWindowInfo();\r\n },\r\n }\r\n }\r\n\n```\n:::"},"getAppBaseInfo":{"name":"## uni.getAppBaseInfo(options?) @getappbaseinfo","description":"获取app基本信息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **GetAppBaseInfoOptions** | 否 | 包含所有字段的过滤对象 | - | \\[options=包含所有字段的过滤对象] 过滤的字段对象, 不传参数默认为获取全部字段。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filter | Array\\ | 是 | - | - | 过滤字段的字符串数组，假如要获取指定字段，传入此数组。 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **GetAppBaseInfoResult** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| appId | string | 否 | - | | manifest.json 中应用appid，即DCloud appid。\t
|\n@| appName | string | 否 | - | | `manifest.json` 中应用名称。
|\n@| appVersion | string | 否 | - | | `manifest.json` 中应用版本名称。
|\n@| appVersionCode | string | 否 | - | | `manifest.json` 中应用版本名号。
|\n@| appLanguage | string | 否 | - | | 应用设置的语言en、zh-Hans、zh-Hant、fr、es\t
|\n@| language | string | 否 | - | | 应用设置的语言\t
|\n@| ~~version~~ | string | 否 | - | | 引擎版本号。已废弃，仅为了向下兼容保留 **已废弃，仅为了向下兼容保留** |\n@| isUniAppX | boolean | 否 | - | | 是否uni-app x
|\n@| ~~uniCompileVersion~~ | string | 否 | - | | uni 编译器版本 **已废弃，仅为了向下兼容保留** |\n@| uniCompilerVersion | string | 否 | - | | uni 编译器版本
|\n@| uniPlatform | \"app\" \\| \"web\" \\| \"mp-weixin\" \\| \"mp-alipay\" \\| \"mp-baidu\" \\| \"mp-toutiao\" \\| \"mp-lark\" \\| \"mp-qq\" \\| \"mp-kuaishou\" \\| \"mp-jd\" \\| \"mp-360\" \\| \"quickapp-webview\" \\| \"quickapp-webview-union\" \\| \"quickapp-webview-huawei\" | 否 | - | | uni-app 运行平台。
|\n@| uniRuntimeVersion | string | 否 | - | | uni 运行时版本
|\n@| ~~uniCompileVersionCode~~ | number | 否 | - | | uni 编译器版本号 **已废弃，仅为了向下兼容保留** |\n@| uniCompilerVersionCode | number | 否 | - | | uni 编译器版本号
|\n@| uniRuntimeVersionCode | number | 否 | - | | uni 运行时版本号
|\n@| packageName | string | 否 | - | | Android的包名
|\n@| bundleId | string | 否 | - | | iOS的bundleId
|\n@| signature | string | 否 | - | | Android: 应用签名证书的SHA1值（全部为小写，中间不包含“:”）。 为了保证应用的安全性，请使用自己生成的证书（不要使用公共测试证书）。
iOS: 应用签名证书中绑定的Bundle ID（AppleID）的md5值（全部为小写）。
|\n@| appTheme | \"light\" \\| \"dark\" \\| \"auto\" | 否 | - | | 当前App的主题
| \n","compatibility":"### getAppBaseInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/getAppBaseInfo.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-app-base-info)\n"},"get-app-base-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-app-base-info/get-app-base-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-app-base-info/get-app-base-info\n>Template\n```vue\n\r\n\r\n\r\n\r\n\n```\n>Script\n```uts\n\n\ttype Item = {\n\t\tlabel : string,\n\t\tvalue : string,\n\t}\n\texport default {\r\n\t\tdata() {\r\n\t\t\treturn {\r\n\t\t\t\ttitle: 'getAppBaseInfo',\n\t\t\t\titems: [] as Item[],\r\n\t\t\t}\r\n\t\t},\r\n\t\tonUnload:function(){\r\n\t\t},\r\n\t\tmethods: {\r\n\t\t\tgetAppBaseInfo: function () {\n\t\t\t\tconst res = uni.getAppBaseInfo();\n const res_str = JSON.stringify(res);\n const res_obj = JSON.parseObject(res_str);\n const res_map = res_obj!.toMap();\n let keys = [] as string[]\n res_map.forEach((_, key) => {\n keys.push(key);\n });\n\n this.items = [] as Item[];\n keys.sort().forEach( key => {\n const value = res[key];\n if(value != null){\n const item = {\n \tlabel: key,\n \tvalue: \"\" + ((typeof value == \"object\")? JSON.stringify(value) : value)\n } as Item;\n this.items.push(item);\n }\n });\n\n\t\t\t}\r\n\t\t}\r\n\t}\r\n\n```\n:::"},"getAppAuthorizeSetting":{"name":"## uni.getAppAuthorizeSetting() @getappauthorizesetting","description":"获取 APP 授权设置。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **GetAppAuthorizeSettingResult** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| albumAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" | 否 | - | | 允许 App 使用相册的开关（仅 iOS 支持）
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） |\n@| bluetoothAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 否 | - | | 允许 App 使用蓝牙的开关（仅 iOS 支持）
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
- config error: Android平台没有该值；iOS平台：表示没有在 `manifest.json -> App模块配置` 中配置 `BlueTooth(低功耗蓝牙)` 模块 |\n@| cameraAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 是 | - | | 允许 App 使用摄像头的开关
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
- config error: Android平台：表示没有配置 `android.permission.CAMERA` 权限，[权限配置详情](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#permissions)；iOS平台没有该值 |\n@| locationAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 是 | - | | 允许 App 使用定位的开关
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
- config error: Android平台：表示没有配置 `android.permission.ACCESS_COARSE_LOCATION` 权限，[权限配置详情](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#permissions)；iOS平台：表示没有在 `manifest.json -> App模块配置` 中配置 `Geolocation(定位)` 模块 |\n@| locationAccuracy | \"reduced\" \\| \"full\" \\| \"unsupported\" | 否 | - | | 定位准确度。
- reduced: 模糊定位
- full: 精准定位
- unsupported: 不支持（包括用户拒绝定位权限和没有在 `manifest.json -> App模块配置` 中配置 `Geolocation(定位)` 模块） |\n@| locationReducedAccuracy | boolean \\| null | 否 | - | | 定位准确度（推荐使用 locationAccuracy 属性）。true 表示模糊定位，false 表示精确定位（仅 iOS 支持） |\n@| microphoneAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 是 | - | | 允许 App 使用麦克风的开关
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
- config error: Android平台：表示没有配置 `android.permission.RECORD_AUDIO` 权限，[权限配置详情](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#permissions)；iOS平台没有该值 |\n@| notificationAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 是 | - | | 允许 App 通知的开关
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
- config error: Android平台没有该值；iOS平台：表示没有在 `manifest.json -> App模块配置` 中配置 `Push(推送)` 模块 |\n@| notificationAlertAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 否 | - | | 允许 App 通知带有提醒的开关（仅 iOS 支持）
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
- config error: 没有在 `manifest.json -> App模块配置` 中配置 `Push(推送)` 模块 |\n@| notificationBadgeAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 否 | - | | 允许 App 通知带有标记的开关（仅 iOS 支持）
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
- config error: 没有在 `manifest.json -> App模块配置` 中配置 `Push(推送)` 模块 |\n@| notificationSoundAuthorized | \"authorized\" \\| \"denied\" \\| \"not determined\" \\| \"config error\" | 否 | - | | 允许 App 通知带有声音的开关（仅 iOS 支持）
- authorized: 已经获得授权，无需再次请求授权
- denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
- not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
- config error: 没有在 `manifest.json -> App模块配置` 中配置 `Push(推送)` 模块 | \n","compatibility":"### getAppAuthorizeSetting 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | x |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/system/getappauthorizesetting)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-app-authorize-setting)\n"},"get-app-authorize-setting":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-app-authorize-setting/get-app-authorize-setting.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\r\n\r\n\r\n\n\n```"},"getSystemSetting":{"name":"## uni.getSystemSetting() @getsystemsetting","description":"获取系统设置","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **GetSystemSettingResult** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| bluetoothEnabled | boolean | 否 | - | | 蓝牙是否开启
|\n@| bluetoothError | string | 否 | - | | 蓝牙的报错信息
|\n@| locationEnabled | boolean | 是 | - | | 位置是否开启
|\n@| wifiEnabled | boolean | 否 | - | | wifi是否开启
|\n@| wifiError | string | 否 | - | | wifi的报错信息
|\n@| deviceOrientation | \"portrait\" \\| \"landscape\" | 是 | - | | 设备方向
| \n","compatibility":"### getSystemSetting 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/getsystemsetting.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-system-setting)\n"},"get-system-setting":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-system-setting/get-system-setting.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\r\n\r\n\r\n\n\n```"},"installApk":{"name":"## uni.installApk(options) @installapk","description":"安装apk","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [InstallApkOptions](#installapkoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | string | 是 | - | - | apk文件地址 |\n@| success | (res: [InstallApkSuccess](#installapksuccess-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (err: [InstallApkFail](#installapkfail-values)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### InstallApkSuccess 的属性值 @installapksuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | 安装成功消息 |\n\n##### InstallApkFail 的属性值 @installapkfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | 错误码
- 1300002 找不到文件 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### installApk 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.94 | x | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.install-apk)\n"},"install-apk":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/install-apk/install-apk.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\r\n\r\n\n\n```"},"getPushClientId":{"name":"## uni.getPushClientId(options) @getpushclientid","description":"获取客户端唯一的推送标识","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetPushClientIdOptions](#getpushclientidoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (result: [GetPushClientIdSuccess](#getpushclientidsuccess-values)) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetPushClientIdSuccess 的属性值 @getpushclientidsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| cid | string | 是 | - | | 个推客户端推送id，对应uni-id-device表的push_clientid
|\n| errMsg | string | 是 | - | | 错误描述
|\n","returnValue":"","compatibility":"### getPushClientId 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.98 | 4.18 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/plugins/push.html#getpushclientid)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.getPushClientId)\n"},"onPushMessage":{"name":"## uni.onPushMessage(callback) @onpushmessage","description":"启动监听推送消息事件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [OnPushMessageCallbackResult](#onpushmessagecallbackresult-values)) => void | 是 | - | - | | \n\n#### OnPushMessageCallbackResult 的属性值 @onpushmessagecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | \"click\" \\| \"receive\" | 是 | - | | 事件类型
- click 从系统推送服务点击消息启动应用事件
- receive 应用从推送服务器接收到推送消息事件 |\n| data | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | | 消息内容
|\n","returnValue":"","compatibility":"### onPushMessage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.98 | 4.18 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/plugins/push.html#onpushmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.onPushMessage)\n"},"offPushMessage":{"name":"## uni.offPushMessage(callback) @offpushmessage","description":"关闭推送消息监听事件，iOS端调用会关闭所有监听。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [OnPushMessageCallbackResult](#onpushmessagecallbackresult-values)) => void | 是 | - | - | | \n\n#### OnPushMessageCallbackResult 的属性值 @onpushmessagecallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | \"click\" \\| \"receive\" | 是 | - | | 事件类型
- click 从系统推送服务点击消息启动应用事件
- receive 应用从推送服务器接收到推送消息事件 |\n| data | [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) | 是 | - | | 消息内容
|\n","returnValue":"","compatibility":"### offPushMessage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.98 | 4.18 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/plugins/push.html#offpushmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.offPushMessage)\n"},"getChannelManager":{"name":"## uni.getChannelManager() @getchannelmanager","description":"获取通知渠道管理器，Android 8系统以上才可以设置通知渠道，Android 8系统以下返回null。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [ChannelManager](#channelmanager-values) |\n\n#### ChannelManager 的方法 @channelmanager-values \n\n#### setPushChannel(options) @setpushchannel\n设置推送渠道
\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **SetPushChannelOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| soundName | string \\| null | 否 | null | - | 添加的声音文件，注意raw目录下必须要有 ，不传此字段将使用默认铃音。 |\n@| channelId | string | 是 | - | - | 通知渠道id |\n@| channelDesc | string | 是 | - | - | 通知渠道描述 |\n@| enableLights | boolean \\| null | 否 | false | - | 呼吸灯闪烁 |\n@| enableVibration | boolean \\| null | 否 | false | - | 震动 |\n@| importance | number \\| null | 否 | 3 | - | 通知的重要性级别，可选范围IMPORTANCE_LOW：2、IMPORTANCE_DEFAULT：3、IMPORTANCE_HIGH：4 。 |\n@| lockscreenVisibility | number \\| null | 否 | -1000 | - | 锁屏可见性，可选范围VISIBILITY_PRIVATE：0、VISIBILITY_PUBLIC：1、VISIBILITY_SECRET：-1、VISIBILITY_NO_OVERRIDE：-1000。 | \n\n\n##### setPushChannel 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.98 | x | - |\n\n\n#### getAllChannels() @getallchannels\n获取当前应用注册的所有的通知渠道。
\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Array\\ |\n \n\n##### getAllChannels 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.98 | x | - |\n\n \n","compatibility":"### getChannelManager 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.98 | x | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.getChannelManager)\n"},"createPushMessage":{"name":"## uni.createPushMessage(options) @createpushmessage","description":"创建本地通知栏消息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **CreatePushMessageOptions** | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| cover | boolean \\| null | 否 | false | | 是否覆盖上一次提示的消息 |\n@| delay | number \\| null | 否 | 0 | | 提示消息延迟显示的时间,单位为s |\n@| icon | string \\| null | 否 | null | | 推送消息的图标 |\n@| sound | string \\| null | 否 | \"system\" | | 推送消息的提示音
- system: 使用系统通知提示音（默认值）
- none: 不使用提示音 |\n@| title | string \\| null | 否 | App的名称 | | 推送消息的标题 |\n@| content | string | 是 | - | | 消息显示的内容，在系统通知中心中显示的文本内容
|\n@| payload | any \\| null | 否 | null | | 消息承载的数据，可根据业务逻辑自定义数据格式 |\n@| when | number \\| null | 否 | 当前时间 | | 消息上显示的提示时间 |\n@| channelId | string \\| null | 否 | \"DcloudChannelID\" | | 渠道id |\n@| category | string \\| null | 否 | null | | 通知类别 |\n@| success | (result: CreatePushMessageSuccess) => void \\| null | 否 | null | - | 接口调用成功的回调函数 |\n@| fail | (result: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | null | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | null | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n","returnValue":"","compatibility":"### createPushMessage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.98 | 4.18 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/plugins/push.html#createpushmessage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.push.uni-push.createPushMessage)\n"},"getBatteryInfo":{"name":"## uni.getBatteryInfo(options) @getbatteryinfo","description":"获取电池电量信息
> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-getbatteryinfo](https://ext.dcloud.net.cn/plugin?name=uni-getbatteryinfo)
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetBatteryInfoOptions](#getbatteryinfooptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (res: [GetBatteryInfoSuccess](#getbatteryinfosuccess-values)) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |\n@| fail | (res: UniError) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void | 否 | - | - | 接口调用成功的回调 | \n\n##### GetBatteryInfoSuccess 的属性值 @getbatteryinfosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n| level | number | 是 | - | - | 设备电量，范围1 - 100 |\n| isCharging | boolean | 是 | - | - | 是否正在充电中 |\n","returnValue":"","compatibility":"### getBatteryInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-battery-info.getBatteryInfo)\n"},"getBatteryInfoSync":{"name":"## uni.getBatteryInfoSync() @getbatteryinfosync","description":"获取电池电量信息
> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-getbatteryinfo](https://ext.dcloud.net.cn/plugin?name=uni-getbatteryinfo)
","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **GetBatteryInfoResult** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| level | number | 是 | - | - | 设备电量，范围1 - 100 |\n@| isCharging | boolean | 是 | - | - | 是否正在充电中 | \n","compatibility":"### getBatteryInfoSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.get-battery-info.getBatteryInfoSync)\n"},"get-battery-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-battery-info/get-battery-info.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-battery-info/get-battery-info\n>Template\n```vue\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n level: 0,\n isCharging: false\n }\n },\n onLoad() {\n try {\n uni.getBatteryInfo({\n success: res => {\n this.level = res.level;\n this.isCharging = res.isCharging;\n }\n });\n } catch (e) {\n console.error((e as Error).message);\n uni.showModal({\n content: (e as Error).message,\n showCancel: false\n });\n }\n }\n }\n\n```\n:::"},"startWifi":{"name":"## uni.startWifi(option) @startwifi","description":"初始化Wi-Fi模块

> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| option | [WifiOption](#wifioption-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - | - |\n@| fail | (res: UniError) => void | 否 | - | - | - |\n@| complete | (res: any) => void | 否 | - | - | - | \n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | - |\n| errMsg | string | 是 | - | - | - |\n| wifi | **UniWifiInfo** \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| SSID | string | 是 | - | - | - |\n@| BSSID | string | 否 | - | - | - |\n@| secure | boolean | 否 | - | - | - |\n@| signalStrength | number | 否 | - | - | - |\n@| frequency | number | 否 | - | - | - |\n","returnValue":"","compatibility":"### startWifi 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#startwifi)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.startWifi)\n"},"stopWifi":{"name":"## uni.stopWifi(option) @stopwifi","description":"关闭 Wi-Fi 模块

> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| option | [WifiOption](#wifioption-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - | - |\n@| fail | (res: UniError) => void | 否 | - | - | - |\n@| complete | (res: any) => void | 否 | - | - | - | \n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | - |\n| errMsg | string | 是 | - | - | - |\n| wifi | **UniWifiInfo** \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| SSID | string | 是 | - | - | - |\n@| BSSID | string | 否 | - | - | - |\n@| secure | boolean | 否 | - | - | - |\n@| signalStrength | number | 否 | - | - | - |\n@| frequency | number | 否 | - | - | - |\n","returnValue":"","compatibility":"### stopWifi 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| x | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#stopwifi)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.stopWifi)\n"},"connectWifi":{"name":"## uni.connectWifi(option) @connectwifi","description":"","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| option | [WifiConnectOption](#wificonnectoption-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| SSID | string | 否 | - | - | - |\n@| BSSID | string | 否 | - | - | - |\n@| password | string | 否 | - | - | - |\n@| maunal | boolean | 否 | - | - | - |\n@| partialInfo | boolean | 否 | - | - | - |\n@| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - | - |\n@| fail | (res: UniError) => void | 否 | - | - | - |\n@| complete | (res: any) => void | 否 | - | - | - | \n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | - |\n| errMsg | string | 是 | - | - | - |\n| wifi | **UniWifiInfo** \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| SSID | string | 是 | - | - | - |\n@| BSSID | string | 否 | - | - | - |\n@| secure | boolean | 否 | - | - | - |\n@| signalStrength | number | 否 | - | - | - |\n@| frequency | number | 否 | - | - | - |\n","returnValue":"","compatibility":"### connectWifi 兼容性 \n| Android 系统版本 | Android | iOS | web |\n| :- | :- | :- | :- |\n| >=4.4 && <10.0 | 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#connectWifi)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.connectWifi)\n"},"getWifiList":{"name":"## uni.getWifiList(option) @getwifilist","description":"请求获取 Wi-Fi 列表。wifiList 数据会在 onGetWifiList 注册的回调中返回。
> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| option | [WifiOption](#wifioption-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - | - |\n@| fail | (res: UniError) => void | 否 | - | - | - |\n@| complete | (res: any) => void | 否 | - | - | - | \n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | - |\n| errMsg | string | 是 | - | - | - |\n| wifi | **UniWifiInfo** \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| SSID | string | 是 | - | - | - |\n@| BSSID | string | 否 | - | - | - |\n@| secure | boolean | 否 | - | - | - |\n@| signalStrength | number | 否 | - | - | - |\n@| frequency | number | 否 | - | - | - |\n","returnValue":"","compatibility":"### getWifiList 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#getWifiList)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.getWifiList)\n"},"onGetWifiList":{"name":"## uni.onGetWifiList(callback) @ongetwifilist","description":"监听获取到 Wi-Fi 列表数据事件。

> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (wifiInfo: any) => void | 是 | - | - | | \n","returnValue":"","compatibility":"### onGetWifiList 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#onGetWifiList)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.onGetWifiList)\n"},"offGetWifiList":{"name":"## uni.offGetWifiList(callback) @offgetwifilist","description":"移除获取到 Wi-Fi 列表数据事件的监听函数。

> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | | \n","returnValue":"","compatibility":"### offGetWifiList 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#offGetWifiList)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.offGetWifiList)\n"},"getConnectedWifi":{"name":"## uni.getConnectedWifi(option) @getconnectedwifi","description":"获取已连接的 Wi-Fi 信息

> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| option | [GetConnectedWifiOptions](#getconnectedwifioptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| partialInfo | boolean | 否 | - | - | - |\n@| success | (res: [UniWifiResult](#uniwifiresult-values)) => void | 否 | - | - | - |\n@| fail | (res: UniError) => void | 否 | - | - | - |\n@| complete | (res: any) => void | 否 | - | - | - | \n\n##### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | - |\n| errMsg | string | 是 | - | - | - |\n| wifi | **UniWifiInfo** \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| SSID | string | 是 | - | - | - |\n@| BSSID | string | 否 | - | - | - |\n@| secure | boolean | 否 | - | - | - |\n@| signalStrength | number | 否 | - | - | - |\n@| frequency | number | 否 | - | - | - |\n","returnValue":"","compatibility":"### getConnectedWifi 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#getConnectedWifi)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.getConnectedWifi)\n"},"onWifiConnected":{"name":"## uni.onWifiConnected(callback) @onwificonnected","description":"监听连接上 Wi-Fi 的事件

> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (wifiInfo: [UniWifiResult](#uniwifiresult-values)) => void | 是 | - | - | | \n\n#### UniWifiResult 的属性值 @uniwifiresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | - |\n| errSubject | string | 是 | - | - | - |\n| errMsg | string | 是 | - | - | - |\n| wifi | **UniWifiInfo** \\| null | 否 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| SSID | string | 是 | - | - | - |\n@| BSSID | string | 否 | - | - | - |\n@| secure | boolean | 否 | - | - | - |\n@| signalStrength | number | 否 | - | - | - |\n@| frequency | number | 否 | - | - | - |\n","returnValue":"","compatibility":"### onWifiConnected 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#onWifiConnected)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.onWifiConnected)\n"},"onWifiConnectedWithPartialInfo":{"name":"## uni.onWifiConnectedWithPartialInfo(callback) @onwificonnectedwithpartialinfo","description":"监听连接上 Wi-Fi 的事件。

> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (wifiInfo: [UniWifiInfoWithPartialInfo](#uniwifiinfowithpartialinfo-values)) => void | 是 | - | - | | \n\n#### UniWifiInfoWithPartialInfo 的属性值 @uniwifiinfowithpartialinfo-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| SSID | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### onWifiConnectedWithPartialInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#onWifiConnectedWithPartialInfo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.onWifiConnectedWithPartialInfo)\n"},"offWifiConnected":{"name":"## uni.offWifiConnected(callback?) @offwificonnected","description":"移除连接上 Wi-Fi 的事件的监听函数。

> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-wifi](https://ext.dcloud.net.cn/plugin?name=uni-wifi)
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void \\| null | 否 | - | - | | \n","returnValue":"","compatibility":"### offWifiConnected 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/wifi.html#offWifiConnected)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.wifi.offWifiConnected)\n"},"onMemoryWarning":{"name":"## uni.onMemoryWarning(callback) @onmemorywarning","description":"开启监听内存警告

> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-memorywarning](https://ext.dcloud.net.cn/plugin?name=uni-memorywarning)
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: [MemoryWarningCallbackResult](#memorywarningcallbackresult-values)) => void | 是 | - | - | | \n\n#### MemoryWarningCallbackResult 的属性值 @memorywarningcallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| level | number | 是 | - | - | 内存警告等级(仅安卓平台有效，iOS始终是0) |\n","returnValue":"","compatibility":"### onMemoryWarning 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/memory.html#onmemorywarning)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.memory.onMemoryWarning)\n"},"offMemoryWarning":{"name":"## uni.offMemoryWarning(callback?) @offmemorywarning","description":"取消监听内存不足告警事件

> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-memorywarning](https://ext.dcloud.net.cn/plugin?name=uni-memorywarning)
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: [MemoryWarningCallbackResult](#memorywarningcallbackresult-values)) => void \\| null | 否 | - | - | | \n\n#### MemoryWarningCallbackResult 的属性值 @memorywarningcallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| level | number | 是 | - | - | 内存警告等级(仅安卓平台有效，iOS始终是0) |\n","returnValue":"","compatibility":"### offMemoryWarning 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/memory.html#offmemorywarning)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.memory.offMemoryWarning)\n"},"onUserCaptureScreen":{"name":"## uni.onUserCaptureScreen(callback?) @onusercapturescreen","description":"开启截屏监听

> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-usercapturescreen](https://ext.dcloud.net.cn/plugin?name=uni-usercapturescreen)
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: [OnUserCaptureScreenCallbackResult](#onusercapturescreencallbackresult-values)) => void \\| null | 否 | - | - | | \n\n#### OnUserCaptureScreenCallbackResult 的属性值 @onusercapturescreencallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| path | string | 否 | - | - | 截屏文件路径（仅Android返回） |\n","returnValue":"","compatibility":"### onUserCaptureScreen 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/capture-screen.html#onusercapturescreen)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.captureScreen.onUserCaptureScreen)\n"},"offUserCaptureScreen":{"name":"## uni.offUserCaptureScreen(callback?) @offusercapturescreen","description":"关闭截屏监听

> 本 API 是 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html)，需下载插件：[uni-usercapturescreen](https://ext.dcloud.net.cn/plugin?name=uni-usercapturescreen)
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: [OnUserCaptureScreenCallbackResult](#onusercapturescreencallbackresult-values)) => void \\| null | 否 | - | - | | \n\n#### OnUserCaptureScreenCallbackResult 的属性值 @onusercapturescreencallbackresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| path | string | 否 | - | - | 截屏文件路径（仅Android返回） |\n","returnValue":"","compatibility":"### offUserCaptureScreen 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/capture-screen.html#offusercapturescreen)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.captureScreen.offUserCaptureScreen)\n"},"createRequestPermissionListener":{"name":"## uni.createRequestPermissionListener() @createrequestpermissionlistener","description":"创建一个监听权限申请的对象。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [RequestPermissionListener](#requestpermissionlistener-values) |\n\n#### RequestPermissionListener 的方法 @requestpermissionlistener-values \n\n#### onRequest(callback) @onrequest\n监听申请系统权限\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (permissions: Array\\) => void | 是 | - | - | 申请系统权限回调，permissions为触发权限申请的所有权限 | \n\n\n##### onRequest 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### onConfirm(callback) @onconfirm\n监听弹出系统权限授权框\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (permissions: Array\\) => void | 是 | - | - | 弹出系统权限授权框回调，permissions为触发弹出权限授权框的所有权限 | \n\n\n##### onConfirm 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### onComplete(callback) @oncomplete\n监听权限申请完成\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (permissions: Array\\) => void | 是 | - | - | 权限申请完成回调，permissions为申请完成的所有权限 | \n\n\n##### onComplete 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### stop() @stop\n取消所有监听\n\n\n##### stop 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n","compatibility":"### createRequestPermissionListener 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.0 | - | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.createRequestPermissionListener)\n","example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/create-request-permission-listener/create-request-permission-listener.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"chooseImage":{"name":"## uni.chooseImage(options) @chooseimage","description":"从本地相册选择图片或使用相机拍照","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ChooseImageOptions](#chooseimageoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| count | number \\| null | 否 | 9 | - | 最多可以选择的图片张数，app端不限制，微信小程序最多可支持20个。 |\n@| sizeType | Array\\ \\| null | 否 | ['original','compressed'\\] | - | original 原图，compressed 压缩图，默认二者都有 |\n@| sourceType | Array\\ \\| null | 否 | ['album','camera'\\] | - | album 从相册选图，camera 使用相机，默认二者都有 |\n@| crop | **ChooseImageCropOptions** \\| null | 否 | - | - | 图像裁剪参数，设置后 sizeType 失效。 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| width | number | 是 | - | - | 裁剪的宽度，单位为px，用于计算裁剪宽高比。 |\n@@| height | number | 是 | - | - | 裁剪的高度，单位为px，用于计算裁剪宽高比。 |\n@@| quality | number \\| null | 否 | 80 | - | 取值范围为1-100，数值越小，质量越低（仅对jpg格式有效）。默认值为80。 |\n@@| resize | boolean \\| null | 否 | - | - | 是否将width和height作为裁剪保存图片真实的像素值。默认值为true。注：设置为false时在裁剪编辑界面显示图片的像素值，设置为true时不显示。 |\n@| success | (callback: [ChooseImageSuccess](#chooseimagesuccess-values)) => void \\| null | 否 | - | - | 成功则返回图片的本地文件路径列表 tempFilePaths |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### ChooseImageSuccess 的属性值 @chooseimagesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errSubject | string | 是 | - | - | 调用API的名称 |\n| errMsg | string | 是 | - | - | 描述信息 |\n| tempFilePaths | Array\\ | 是 | - | - | 图片的本地文件路径列表 |\n| tempFiles | any | 是 | - | - | 图片的本地文件列表 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### chooseImage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/image?id=chooseimage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.choose-image)\n"},"choose-image":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/choose-image/choose-image.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/choose-image/choose-image\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n var sourceTypeArray = [\n ['camera'],\n ['album'],\n ['camera', 'album']\n ]\n var sizeTypeArray = [\n ['compressed'],\n ['original'],\n ['compressed', 'original']\n ]\n export default {\n data() {\n return {\n title: 'chooseImage',\n imageList: [] as Array,\n sourceTypeIndex: 2,\n sourceType: ['拍照', '相册', '拍照或相册'],\n sizeTypeIndex: 2,\n sizeType: ['压缩', '原图', '压缩或原图'],\n countIndex: 8,\n count: [1, 2, 3, 4, 5, 6, 7, 8, 9],\n isCrop: false,\n cropPercent: 80,\n cropWidth: 100,\n cropHeight: 100,\n cropResize: false\n }\n },\n onUnload() {\n this.imageList = [];\n this.sourceTypeIndex = 2\n this.sourceType = ['拍照', '相册', '拍照或相册']\n this.sizeTypeIndex = 2\n this.sizeType = ['压缩', '原图', '压缩或原图']\n this.countIndex = 8\n },\n methods: {\n cropHeightConfim(e : InputConfirmEvent) {\n let value = parseInt(e.detail.value)\n if (value > 0) {\n this.cropHeight = value\n } else {\n uni.showToast({\n position: \"bottom\",\n title: \"裁剪高度需要大于0\"\n })\n }\n },\n cropWidthConfim(e : InputConfirmEvent) {\n let value = parseInt(e.detail.value)\n if (value > 0) {\n this.cropWidth = value\n } else {\n uni.showToast({\n position: \"bottom\",\n title: \"裁剪宽度需要大于0\"\n })\n }\n },\n cropPercentConfim(e : InputConfirmEvent) {\n let value = parseInt(e.detail.value)\n if (value > 0 && value <= 100) {\n this.cropPercent = value\n } else {\n uni.showToast({\n position: \"bottom\",\n title: \"请输入0~100之间的值\"\n })\n }\n },\n cropResizeChange(e : UniSwitchChangeEvent) {\n this.cropResize = e.detail.value\n },\n switchCrop(e : UniSwitchChangeEvent) {\n this.isCrop = e.detail.value\n },\n removeImage(index : number) {\n this.imageList.splice(index, 1)\n },\n chooseImageSource() {\n uni.showActionSheet({\n itemList: ['拍照', '相册', '拍照或相册'],\n success: (e) => {\n this.sourceTypeIndex = e.tapIndex!\n }\n })\n },\n chooseImageType() {\n uni.showActionSheet({\n itemList: ['压缩', '原图', '压缩或原图'],\n success: (e) => {\n this.sizeTypeIndex = e.tapIndex!\n }\n })\n },\n chooseImageCount(event : InputConfirmEvent) {\n let count = parseInt(event.detail.value) - 1\n if (count < 0) {\n uni.showToast({\n position: \"bottom\",\n title: \"图片数量应该大于0\"\n })\n return\n }\n this.countIndex = count\n },\n chooseImage: function () {\n // var cropOption:ChooseImageCropOptions|null = this.isCrop ? null : new ChooseImageCropOptions( )\n if (this.imageList.length >= 9) {\n uni.showToast({\n position: \"bottom\",\n title: \"已经有9张图片了，请删除部分图片之后重新选择\"\n })\n return\n }\n uni.chooseImage({\n sourceType: sourceTypeArray[this.sourceTypeIndex],\n sizeType: sizeTypeArray[this.sizeTypeIndex],\n crop: this.isCrop ? { \"quality\": this.cropPercent, \"width\": this.cropWidth, \"height\": this.cropHeight, \"resize\": this.cropResize } as ChooseImageCropOptions : null,\n count: this.imageList.length + this.count[this.countIndex] > 9 ? 9 - this.imageList.length : this.count[this.countIndex],\n success: (res) => {\n this.imageList = this.imageList.concat(res.tempFilePaths);\n },\n fail: (err) => {\n console.log(\"err: \", JSON.stringify(err));\n }\n })\n },\n previewImage: function (index : number) {\n uni.previewImage({\n current: index,\n urls: this.imageList\n })\n }\n }\n }\n\n```\n:::"},"previewImage":{"name":"## uni.previewImage(options) @previewimage","description":"预览图片","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [PreviewImageOptions](#previewimageoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| current | any \\| null | 否 | - | - | current 为当前显示图片的链接/索引值，不填或填写的值无效则为 urls 的第一张。 |\n@| urls | Array\\<[string.ImageURIString](/uts/data-type.md#ide-string)\\> | 是 | - | - | 需要预览的图片链接列表 |\n@| indicator | string \\| null | 否 | - | - | 图片指示器样式
- default: 底部圆点指示器
- number: 顶部数字指示器
- none: 不显示指示器 |\n@| loop | boolean \\| null | 否 | - | - | 是否可循环预览 |\n@| success | (callback: [PreviewImageSuccess](#previewimagesuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### PreviewImageSuccess 的属性值 @previewimagesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errSubject | string | 是 | - | - | 调用API的名称 |\n| errMsg | string | 是 | - | - | 描述信息 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### previewImage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/image?id=previewimage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.preview-image.previewImage)\n"},"closePreviewImage":{"name":"## uni.closePreviewImage(options) @closepreviewimage","description":"关闭图片预览","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ClosePreviewImageOptions](#closepreviewimageoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (callback: [ClosePreviewImageSuccess](#closepreviewimagesuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### ClosePreviewImageSuccess 的属性值 @closepreviewimagesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | 错误信息 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### closePreviewImage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/image?id=closepreviewimage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.preview-image.closePreviewImage)\n"},"preview-image":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/preview-image/preview-image.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/preview-image/preview-image\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n type ItemType = {\n value : string,\n name : string\n }\n\n export default {\n data() {\n return {\n imageList: [\"https://qiniu-web-assets.dcloud.net.cn/unidoc/zh/uni@2x.png\", \"/static/uni.png\"],\n indicator: [{\n value: \"default\",\n name: \"圆点\"\n }, {\n value: \"number\",\n name: \"数字\"\n }, {\n value: \"none\",\n name: \"不显示\"\n }] as ItemType[],\n currentIndicator: \"default\",\n isLoop: true\n }\n },\n methods: {\n previewImage(index : number) {\n uni.previewImage({\n urls: this.imageList,\n current: index,\n indicator: this.currentIndicator,\n loop: this.isLoop\n })\n },\n chooseImage() {\n uni.chooseImage({\n sourceType: ['album'],\n success: (e) => {\n this.imageList = this.imageList.concat(e.tempFilePaths)\n },\n fail(_) {\n }\n })\n },\n onIndicatorChanged(e : UniRadioGroupChangeEvent) {\n this.currentIndicator = e.detail.value\n },\n onCheckboxChange(_ : UniCheckboxGroupChangeEvent) {\n this.isLoop = !this.isLoop\n }\n }\n }\n\n```\n:::"},"saveImageToPhotosAlbum":{"name":"## uni.saveImageToPhotosAlbum(options) @saveimagetophotosalbum","description":"保存图片到系统相册","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SaveImageToPhotosAlbumOptions](#saveimagetophotosalbumoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.ImageURIString](/uts/data-type.md#ide-string) | 是 | - | - | 图片文件路径，可以是临时文件路径也可以是永久文件路径，不支持网络图片路径 |\n@| success | (callback: [SaveImageToPhotosAlbumSuccess](#saveimagetophotosalbumsuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SaveImageToPhotosAlbumSuccess 的属性值 @saveimagetophotosalbumsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| path | string | 是 | - | - | 保存到相册的图片路径 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### saveImageToPhotosAlbum 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/image?id=saveimagetophotosalbum)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.save-image-to-photos-album)\n"},"save-image-to-photos-album":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/save-image-to-photos-album/save-image-to-photos-album.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"getImageInfo":{"name":"## uni.getImageInfo(options) @getimageinfo","description":"获取图片信息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetImageInfoOptions](#getimageinfooptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| src | [string.ImageURIString](/uts/data-type.md#ide-string) | 是 | - | - | 图片的路径，可以是相对路径，临时文件路径，存储文件路径，网络图片路径 |\n@| success | (callback: [GetImageInfoSuccess](#getimageinfosuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetImageInfoSuccess 的属性值 @getimageinfosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| width | number | 是 | - | - | 图片宽度，单位px |\n| height | number | 是 | - | - | 图片高度，单位px |\n| path | string | 是 | - | - | 返回图片的本地路径 |\n| orientation | string \\| null | 否 | - | - | 返回图片的方向 |\n| type | string \\| null | 否 | - | - | 返回图片的格式 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### getImageInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | - | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/image?id=getimageinfo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.get-image-info)\n"},"get-image-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-image-info/get-image-info.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"compressImage":{"name":"## uni.compressImage(options) @compressimage","description":"压缩图片","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [CompressImageOptions](#compressimageoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| src | [string.ImageURIString](/uts/data-type.md#ide-string) | 是 | - | - | 图片路径，图片的路径，可以是相对路径、临时文件路径、存储文件路径 |\n@| quality | number \\| null | 否 | - | - | 压缩质量，范围0～100，数值越小，质量越低，压缩率越高（仅对jpg有效） |\n@| rotate | number \\| null | 否 | - | - | 旋转度数，范围0～360 |\n@| width | string \\| null | 否 | - | - | 缩放图片的宽度 |\n@| height | string \\| null | 否 | - | - | 缩放图片的高度 |\n@| compressedHeight | number \\| null | 否 | - | - | 压缩后图片的高度，单位为px，若不填写则默认以compressedWidth为准等比缩放 |\n@| compressedWidth | number \\| null | 否 | - | - | 压缩后图片的宽度，单位为px，若不填写则默认以compressedHeight为准等比缩放。 |\n@| success | (callback: [CompressImageSuccess](#compressimagesuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### CompressImageSuccess 的属性值 @compressimagesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tempFilePath | string | 是 | - | - | 压缩后图片的临时文件路径 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### compressImage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | - | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/image?id=compressimage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.compress-image)\n"},"compress-image":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/compress-image/compress-image.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"chooseVideo":{"name":"## uni.chooseVideo(options) @choosevideo","description":"拍摄视频或从手机相册中选视频，返回视频的临时文件路径。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ChooseVideoOptions](#choosevideooptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| sourceType | Array\\ \\| null | 否 | - | - | album 从相册选视频，camera 使用相机拍摄，默认为：['album', 'camera'\\] |\n@| compressed | boolean \\| null | 否 | true | - | 是否压缩所选的视频源文件，默认值为true，需要压缩 |\n@| maxDuration | number \\| null | 否 | - | - | 拍摄视频最长拍摄时间，单位秒。最长支持 60 秒 |\n@| camera | string \\| null | 否 | - | - | 摄像切换
- front: 前置摄像头
- back: 后置摄像头 |\n@| success | (callback: [ChooseVideoSuccess](#choosevideosuccess-values)) => void \\| null | 否 | - | - | 接口调用成功，返回视频文件的临时文件路径，详见返回参数说明 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### ChooseVideoSuccess 的属性值 @choosevideosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tempFilePath | string | 是 | - | - | 选定视频的临时文件路径 |\n| duration | number | 是 | - | - | 选定视频的时间长度 |\n| size | number | 是 | - | - | 选定视频的数据量大小 |\n| height | number | 是 | - | - | 返回选定视频的长 |\n| width | number | 是 | - | - | 返回选定视频的宽 |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### chooseVideo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | 4.18 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/video?id=choosevideo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.choose-video)\n"},"choose-video":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/choose-video/choose-video.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/choose-video/choose-video\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n import { ItemType } from '@/components/enum-data/enum-data';\n export default {\n data() {\n return {\n title: \"chooseVideo\",\n src: \"\",\n sourceTypeItemTypes: [{ \"value\": 0, \"name\": \"从相册中选择视频\" }, { \"value\": 1, \"name\": \"拍摄视频\" }, { \"value\": 2, \"name\": \"从相册中选择视频或拍摄视频\" }] as ItemType[],\n sourceTypeItems: [[\"album\"], [\"camera\"], [\"album\", \"camera\"]],\n cameraItemTypes: [{ \"value\": 0, \"name\": \"后置摄像头\" }, { \"value\": 1, \"name\": \"前置摄像头\" }] as ItemType[],\n cameraItems: [\"back\", \"front\"],\n sourceType: [\"album\", \"camera\"],\n compressed: true,\n maxDuration: 60,\n camera: \"back\",\n videoInfo: \"\"\n }\n },\n methods: {\n chooseVideo() {\n uni.chooseVideo({\n sourceType: this.sourceType,\n // #ifdef APP\n compressed: this.compressed,\n // #endif\n maxDuration: this.maxDuration,\n camera: this.camera,\n success: (res) => {\n console.log(\"chooseVideo success\", JSON.stringify(res));\n this.src = res.tempFilePath;\n this.videoInfo = `视频长度: ${res.duration}s\\n视频大小: ${Math.ceil(res.size / 1024)}KB\\n视频宽度: ${res.width}\\n视频高度: ${res.height}\\n`;\n },\n fail: (err) => {\n uni.showModal({\n title: \"选择视频失败\",\n content: JSON.stringify(err),\n showCancel: false\n });\n }\n });\n },\n onSourceTypeChange(value : number) {\n this.sourceType = this.sourceTypeItems[value];\n },\n onCompressedChange(value : boolean) {\n this.compressed = value;\n },\n onMaxDurationConfirm(value : number) {\n this.maxDuration = value;\n },\n onCameraChange(value : number) {\n this.camera = this.cameraItems[value];\n }\n }\n }\n\n```\n:::"},"saveVideoToPhotosAlbum":{"name":"## uni.saveVideoToPhotosAlbum(options) @savevideotophotosalbum","description":"保存视频到系统相册","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SaveVideoToPhotosAlbumOptions](#savevideotophotosalbumoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.VideoURIString](/uts/data-type.md#ide-string) | 是 | - | - | 视频文件路径，可以是临时文件路径也可以是永久文件路径 |\n@| success | (callback: SaveVideoToPhotosAlbumSuccess) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### saveVideoToPhotosAlbum 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | 4.18 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/video?id=savevideotophotosalbum)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.save-video-to-photos-album)\n"},"save-video-to-photos-album":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/save-video-to-photos-album/save-video-to-photos-album.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"getVideoInfo":{"name":"## uni.getVideoInfo(options) @getvideoinfo","description":"获取视频详细信息","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetVideoInfoOptions](#getvideoinfooptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| src | [string.VideoURIString](/uts/data-type.md#ide-string) | 是 | - | - | 视频文件路径，可以是临时文件路径也可以是永久文件路径 |\n@| success | (callback: [GetVideoInfoSuccess](#getvideoinfosuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetVideoInfoSuccess 的属性值 @getvideoinfosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| orientation | string \\| null | 否 | - | - | 画面方向 |\n| type | string \\| null | 否 | - | - | 视频格式 |\n| duration | number | 是 | - | - | 视频长度 |\n| size | number | 是 | - | - | 视频大小，单位 kB |\n| height | number | 是 | - | - | 视频的长，单位 px |\n| width | number | 是 | - | - | 视频的宽，单位 px |\n| fps | number \\| null | 否 | - | - | 视频帧率 |\n| bitrate | number \\| null | 否 | - | - | 视频码率，单位 kbps |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### getVideoInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | - | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/video?id=getvideoinfo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.get-video-info)\n"},"get-video-info":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-video-info/get-video-info.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"compressVideo":{"name":"## uni.compressVideo(options) @compressvideo","description":"压缩视频","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [CompressVideoOptions](#compressvideooptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| src | [string.VideoURIString](/uts/data-type.md#ide-string) | 是 | - | - | 视频文件路径，可以是临时文件路径也可以是永久文件路径 |\n@| quality | string \\| null | 否 | - | - | 压缩质量
- low: 低
- medium: 中
- high: 高 |\n@| resolution | number \\| null | 否 | - | - | 相对于原视频的分辨率比例，取值范围(0, 1\\] |\n@| success | (callback: [CompressVideoSuccess](#compressvideosuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (callback: [IMediaError](#imediaerror-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (callback: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### CompressVideoSuccess 的属性值 @compressvideosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tempFilePath | string | 是 | - | - | 压缩后的临时文件地址 |\n| size | number | 是 | - | - | 压缩后的大小，单位 kB |\n\n##### IMediaError 的属性值 @imediaerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1101001 \\| 1101002 \\| 1101003 \\| 1101004 \\| 1101005 \\| 1101006 \\| 1101007 \\| 1101008 \\| 1101009 \\| 1101010 | 是 | - | - | 错误码
- 1101001 用户取消
- 1101002 urls至少包含一张图片地址
- 1101003 文件不存在
- 1101004 图片加载失败
- 1101005 未获取权限
- 1101006 图片或视频保存失败
- 1101007 图片裁剪失败
- 1101008 拍照或录像失败
- 1101009 图片压缩失败
- 1101010 其他错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### compressVideo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.18 | - | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/video?id=compressvideo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.compress-video)\n"},"compress-video":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/compress-video/compress-video.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"getLocation":{"name":"## uni.getLocation(options) @getlocation","description":"获取当前的地理位置、速度","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetLocationOptions](#getlocationoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| type | \"wgs84\" \\| \"gcj02\" | 否 | wgs84 | - | 默认为 wgs84 返回 gps 坐标，gcj02 返回可用于uni.openLocation的坐标，web端需配置定位 SDK 信息才可支持 gcj02 |\n@| altitude | boolean \\| null | 否 | false | - | 传入 true 会返回高度信息，由于获取高度需要较高精确度，会减慢接口返回速度 |\n@| geocode | boolean \\| null | 否 | false | - | 传入 true 会解析地址 |\n@| highAccuracyExpireTime | number \\| null | 否 | 3000 | - | 高精度定位超时时间(ms)，指定时间内返回最高精度，该值3000ms以上高精度定位才有效果 |\n@| isHighAccuracy | boolean \\| null | 否 | false | - | 开启高精度定位 |\n@| success | (result: [GetLocationSuccess](#getlocationsuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [IGetLocationFail](#igetlocationfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetLocationSuccess 的属性值 @getlocationsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| latitude | number | 是 | 0 | - | 纬度，浮点数，范围为-90~90，负数表示南纬 |\n| longitude | number | 是 | 0 | - | 经度，范围为-180~180，负数表示西经 |\n| speed | number | 是 | 0 | - | 速度，浮点数，单位m/s |\n| accuracy | number | 是 | - | - | 位置的精确度 |\n| altitude | number | 是 | 0 | - | 高度，单位 m |\n| verticalAccuracy | number | 是 | 0 | - | 垂直精度，单位 m（Android 无法获取，返回 0） |\n| horizontalAccuracy | number | 是 | 0 | - | 水平精度，单位 m |\n| address | any \\| null | 否 | null | - | 地址信息 |\n\n##### IGetLocationFail 的属性值 @igetlocationfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1505004 \\| 1505005 \\| 1505021 \\| 1505022 \\| 1505023 \\| 1505024 \\| 1505025 \\| 1505026 | 是 | - | - | 错误码
- 1505004 缺失权限
- 1505005 缺失高精度权限授权（iOS特有）
- 1505021 超时
- 1505022 不支持的定位类型
- 1505023 不支持逆地理编码
- 1505024 没有找到具体的定位引擎，请定位开关是否已打开
- 1505025 逆地理编码捕获失败
- 1505026 捕获定位失败 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### getLocation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/location/location?id=getlocation)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.location.get-location)\n"},"get-location":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-location/get-location.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-location/get-location\n>Template\n```vue\n\n\n\n```\n>Script\n```uts\n\n type ItemType = {\n value : 'wgs84' | 'gcj02',\n name : string,\n }\n export default {\n data() {\n return {\n title: 'get-location',\n altitudeSelect: false,\n isHighAccuracySelect: false,\n geocodeSelect: false,\n exeRet: '',\n items: [\n {\n value: 'wgs84',\n name: 'wgs84'\n },\n {\n value: 'gcj02',\n name: 'gcj02'\n }\n ] as ItemType[],\n current: 0,\n }\n },\n methods: {\n altitudeChange: function (e : UniSwitchChangeEvent) {\n this.altitudeSelect = e.detail.value\n },\n geocodeChange: function (e : UniSwitchChangeEvent) {\n this.geocodeSelect = e.detail.value\n },\n highAccuracySelectChange: function (e : UniSwitchChangeEvent) {\n this.isHighAccuracySelect = e.detail.value\n },\n radioChange(e : UniRadioGroupChangeEvent) {\n for (let i = 0; i < this.items.length; i++) {\n if (this.items[i].value === e.detail.value) {\n this.current = i;\n break;\n }\n }\n },\n getLocationTap: function () {\n uni.showLoading({\n title: '定位中'\n })\n uni.getLocation(({\n type: this.items[this.current].value,\n altitude: this.altitudeSelect,\n isHighAccuracy: this.isHighAccuracySelect,\n geocode: this.geocodeSelect,\n success: (res : any) => {\n uni.hideLoading()\n console.log(res);\n this.exeRet = JSON.stringify(res)\n },\n fail: (res : any) => {\n uni.hideLoading()\n console.log(res);\n this.exeRet = JSON.stringify(res)\n },\n complete: (res : any) => {\n uni.hideLoading()\n console.log(res);\n this.exeRet = JSON.stringify(res)\n }\n }));\n\n\n }\n\n }\n }\n\n```\n:::"},"getStorageInfo":{"name":"## uni.getStorageInfo(options) @getstorageinfo","description":"uni.getStorageInfo函数定义
异步获取当前 storage 的相关信息。
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetStorageInfoOptions](#getstorageinfooptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (res: [GetStorageInfoSuccess](#getstorageinfosuccess-values)) => void \\| null | 否 | - | - | uni.getStorageInfo成功回调函数定义 |\n@| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | - | - | uni.getStorageInfo失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.getStorageInfo完成回调函数定义 | \n\n##### GetStorageInfoSuccess 的属性值 @getstorageinfosuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| keys | Array\\ | 是 | - | - | 当前 storage 中所有的 key |\n| currentSize | number | 是 | - | - | 当前占用的空间大小, 单位：kb |\n| limitSize | number | 是 | - | - | 限制的空间大小, 单位：kb |\n","returnValue":"","compatibility":"### getStorageInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorageinfo)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.getStorageInfo)\n"},"getStorageInfoSync":{"name":"## uni.getStorageInfoSync() @getstorageinfosync","description":"uni.getStorageInfoSync函数定义
同步获取当前 storage 的相关信息。

","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **GetStorageInfoSuccess** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| keys | Array\\ | 是 | - | - | 当前 storage 中所有的 key |\n@| currentSize | number | 是 | - | - | 当前占用的空间大小, 单位：kb |\n@| limitSize | number | 是 | - | - | 限制的空间大小, 单位：kb | \n","compatibility":"### getStorageInfoSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorageinfosync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.getStorageInfoSync)\n"},"getStorage":{"name":"## uni.getStorage(options) @getstorage","description":"uni.getStorage函数定义
从本地存储中异步获取指定 key 对应的内容。
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetStorageOptions](#getstorageoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| key | string | 是 | - | - | 本地存储中的指定的 key |\n@| success | (res: [GetStorageSuccess](#getstoragesuccess-values)) => void \\| null | 否 | - | - | uni.getStorage成功回调函数定义 |\n@| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | - | - | uni.getStorage失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.getStorage完成回调函数定义 | \n\n##### GetStorageSuccess 的属性值 @getstoragesuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | any \\| null | 否 | - | - | key 对应的内容 |\n","returnValue":"","compatibility":"### getStorage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.getStorage)\n"},"getStorageSync":{"name":"## uni.getStorageSync(key) @getstoragesync","description":"uni.getStorageSync函数定义
从本地存储中同步获取指定 key 对应的内容。
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 本地存储中的指定的 key | \n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| any \\| null | 否 |\n \n","compatibility":"### getStorageSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstoragesync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.getStorageSync)\n"},"setStorage":{"name":"## uni.setStorage(options) @setstorage","description":"uni.setStorage函数定义
将数据存储在本地storage存储中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个异步接口。
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **SetStorageOptions** | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| key | string | 是 | - | - | 本地存储中的指定的 key |\n@| data | any | 是 | - | - | 需要存储的内容，只支持能通过 JSON.stringify 序列化的对象 |\n@| success | (res: SetStorageSuccess) => void \\| null | 否 | - | - | uni.setStorage成功回调函数定义 |\n@| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | - | - | uni.setStorage失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.setStorage完成回调函数定义 | \n","returnValue":"","compatibility":"### setStorage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#setstorage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.setStorage)\n"},"setStorageSync":{"name":"## uni.setStorageSync(key, data) @setstoragesync","description":"uni.setStorageSync函数定义
将 data 存储在本地storage存储中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个同步接口。
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 本地storage存储中的指定的 key |\n| data | any | 是 | - | - | 需要存储的内容，只支持能通过 JSON.stringify 序列化的对象 | \n","returnValue":"","compatibility":"### setStorageSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#setstoragesync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.setStorageSync)\n"},"removeStorage":{"name":"## uni.removeStorage(options) @removestorage","description":"uni.removeStorage函数定义
从本地存储中异步移除指定 key。
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **RemoveStorageOptions** | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| key | string | 是 | - | - | 本地存储中的指定的 key |\n@| success | (res: RemoveStorageSuccess) => void \\| null | 否 | - | - | uni.removeStorage成功回调函数定义 |\n@| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | - | - | uni.removeStorage失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.removeStorage完成回调函数定义 | \n","returnValue":"","compatibility":"### removeStorage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](hhttps://uniapp.dcloud.net.cn/api/storage/storage.html#removestorage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.removeStorage)\n"},"removeStorageSync":{"name":"## uni.removeStorageSync(key) @removestoragesync","description":"uni.removeStorageSync函数定义
从本地存储中同步移除指定 key。
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | 本地存储中的指定的 key | \n","returnValue":"","compatibility":"### removeStorageSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#removestoragesync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.removeStorageSync)\n"},"clearStorage":{"name":"## uni.clearStorage(option?) @clearstorage","description":"uni.clearStorage函数定义
清除本地数据存储。
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| option | **ClearStorageOptions** \\| null | 否 | - | - | uni.removeStorage参数定义 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (res: ClearStorageSuccess) => void \\| null | 否 | - | - | uni.clearStorage 成功回调函数定义 |\n@| fail | (res: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | - | - | uni.clearStorage 失败回调函数定义 |\n@| complete | (res: any) => void \\| null | 否 | - | - | uni.clearStorage 完成回调函数定义 | \n","returnValue":"","compatibility":"### clearStorage 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#clearstorage)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.clearStorage)\n"},"clearStorageSync":{"name":"## uni.clearStorageSync() @clearstoragesync","description":"uni.clearStorageSync函数定义
清除本地数据存储。
","param":"","returnValue":"","compatibility":"### clearStorageSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/storage/storage.html#clearstoragesync)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.storage.storage.clearStorageSync)\n"},"storage":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/storage/storage.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/storage/storage\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: 'get/set/clearStorage',\n key: '',\n data: '' as any,\n apiGetData: '' as any | null,\n storageInfo: '',\n }\n },\n methods: {\n getStorageInfo() {\n uni.getStorageInfo({\n success: (res) => {\n this.apiGetData = res\n this.storageInfo = JSON.stringify(res)\n },\n })\n },\n getStorageInfoSync() {\n try {\n const res = uni.getStorageInfoSync()\n this.apiGetData = res\n this.storageInfo = JSON.stringify(res)\n } catch (e) {\n // error\n console.log(e)\n }\n },\n jsonLikeMock() {\n this.key = 'key_' + Math.random()\n this.data = JSON.stringify({\n name: \"james\",\n age: 12,\n from: \"american\"\n });\n\n },\n longLikeMock() {\n this.key = 'key_' + Math.random()\n this.data = \"1234567890\"\n },\n floatLikeMock() {\n this.key = 'key_' + Math.random()\n this.data = \"321456.1234567890\"\n },\n negativeLikeMock() {\n this.key = 'key_' + Math.random()\n this.data = \"-321456\"\n },\n strMock() {\n this.key = 'key_' + Math.random()\n this.data = '测试字符串数据，长度为16个字符'\n },\n complexMock() {\n this.key = 'key_' + Math.random()\n let jsonObj = {\n name: '张三',\n age: 12,\n classMate: [\n {\n id: 1001,\n name: '李四',\n },\n {\n id: 1002,\n name: 'jack ma',\n },\n ],\n }\n this.data = jsonObj\n },\n numberMock() {\n this.key = 'key_' + Math.random()\n this.data = 10011\n },\n floatMock() {\n this.key = 'key_' + Math.random()\n this.data = 3.1415926535893384626\n },\n\n keyChange: function (e : InputEvent) {\n this.key = e.detail.value\n },\n dataChange: function (e : InputEvent) {\n this.data = e.detail.value\n },\n getStorage: function () {\n var key = this.key\n if (key.length == 0) {\n uni.showModal({\n title: '读取数据失败',\n content: 'key 不能为空',\n showCancel: false,\n })\n } else {\n let that = this\n uni.getStorage({\n key: key,\n success: (res) => {\n\n that.apiGetData = res.data\n let desc : string = typeof this.apiGetData\n if (\"object\" == desc) {\n desc = desc + \": \" + JSON.stringify(this.apiGetData)\n } else {\n desc = desc + \": \" + this.apiGetData\n }\n\n uni.showModal({\n title: '读取数据成功',\n content: desc,\n showCancel: false,\n })\n },\n fail: () => {\n uni.showModal({\n title: '读取数据失败',\n content: '找不到 key 对应的数据',\n showCancel: false,\n })\n },\n })\n }\n },\n getStorageSync: function () {\n var key = this.key\n if (key.length == 0) {\n uni.showModal({\n title: '读取数据失败',\n content: 'key 不能为空',\n showCancel: false,\n })\n } else {\n this.apiGetData = uni.getStorageSync(key)\n\n let desc : string = typeof this.apiGetData\n if (\"object\" == desc) {\n desc = desc + \": \" + JSON.stringify(this.apiGetData)\n } else {\n desc = desc + \": \" + this.apiGetData\n }\n\n uni.showModal({\n title: '读取数据成功',\n content: desc,\n showCancel: false,\n })\n }\n },\n setStorage: function () {\n var key = this.key\n var data = this.data\n if (key.length == 0) {\n uni.showModal({\n title: '保存数据失败',\n content: 'key 不能为空',\n showCancel: false,\n })\n } else {\n uni.setStorage({\n key: key,\n data: data,\n success: () => {\n uni.showModal({\n title: '存储数据成功',\n showCancel: false,\n })\n },\n fail: () => {\n uni.showModal({\n title: '储存数据失败!',\n showCancel: false,\n })\n },\n })\n }\n },\n setStorageSync: function () {\n var key = this.key\n var data = this.data\n if (key.length == 0) {\n uni.showModal({\n title: '保存数据失败',\n content: 'key 不能为空',\n showCancel: false,\n })\n } else {\n uni.setStorageSync(key, data)\n uni.showModal({\n title: '存储数据成功',\n showCancel: false,\n })\n }\n },\n removeStorage: function () {\n uni.removeStorage({\n key: this.key,\n success: () => {\n uni.showModal({\n title: '移除数据成功',\n showCancel: false,\n })\n },\n fail: () => {\n uni.showModal({\n title: '移除数据失败',\n showCancel: false,\n })\n },\n })\n },\n removeStorageSync: function () {\n uni.removeStorageSync(this.key)\n uni.showModal({\n title: '移除数据成功',\n showCancel: false,\n })\n },\n clearStorage: function () {\n this.key = ''\n this.data = ''\n uni.clearStorage({\n success: function (_) {\n uni.showModal({\n title: '清除数据成功',\n showCancel: false,\n })\n },\n fail: function (_) {\n uni.showModal({\n title: '清除数据失败',\n showCancel: false,\n })\n },\n })\n },\n clearStorageSync: function () {\n this.key = ''\n this.data = ''\n uni.clearStorageSync()\n uni.showModal({\n title: '清除数据成功',\n content: ' ',\n showCancel: false,\n })\n },\n },\n }\n\n```\n:::"},"getFileSystemManager":{"name":"## uni.getFileSystemManager() @getfilesystemmanager","description":"获取文件管理器","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [FileSystemManager](#filesystemmanager-values) |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| close | any | 是 | - | | 关闭文件 |\n#### FileSystemManager 的方法 @filesystemmanager-values \n\n#### readFile(options) @readfile\n读取本地文件内容\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ReadFileOptions](#readfileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| encoding | \"base64\" \\| \"utf-8\" | 是 | - | - | base64 / utf-8 |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 文件路径，支持相对地址和绝对地址，app-android平台支持代码包文件目录 |\n@| success | (res: [ReadFileSuccessResult](#readfilesuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 通用的错误返回结果回调 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 通用的结束返回结果回调 | \n\n##### ReadFileSuccessResult 的属性值 @readfilesuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | string | 是 | - | - | - |\n\n##### IFileSystemManagerFail 的属性值 @ifilesystemmanagerfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1200002 \\| 1300002 \\| 1300013 \\| 1300021 \\| 1300022 \\| 1300066 \\| 1301003 \\| 1301005 \\| 1300201 \\| 1300202 \\| 1301111 \\| 1302003 \\| 1300009 | 是 | - | - | 错误码
- 1200002 类型错误。仅支持 base64 / utf-8
- 1300002 未找到文件
- 1300013 无权限
- 1300021 是目录
- 1300022 参数无效
- 1300066 目录非空
- 1301003 对目录的非法操作
- 1301005 文件已存在
- 1300201 系统错误
- 1300202 超出文件存储限制的最大尺寸
- 1301111 brotli解压失败
- 1302003 标志无效
- 1300009 文件描述符错误 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n\n##### readFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### readFileSync(filePath, encoding?) @readfilesync\nFileSystemManager.readFile 的同步版本参数\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filePath | string | 是 | - | - | 文件路径，支持相对地址和绝对地址，app-android平台支持代码包文件目录 |\n| encoding | string \\| null | 否 | - | - | base64 / utf-8 | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| string |\n \n\n##### readFileSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### writeFile(options) @writefile\n写文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [WriteFileOptions](#writefileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 文件路径，只支持绝对地址 |\n@| encoding | \"ascii\" \\| \"base64\" \\| \"utf-8\" | 是 | - | - | 指定写入文件的字符编码
支持:ascii base64 utf-8 |\n@| data | string | 是 | - | - | 写入的文本内容 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 通用的正确返回结果回调 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### FileManagerSuccessResult 的属性值 @filemanagersuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n\n\n##### writeFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### writeFileSync(filePath, data, encoding) @writefilesync\nFileSystemManager.writeFile 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filePath | string | 是 | - | - | 文件路径，只支持绝对地址 |\n| data | string | 是 | - | - | 写入的文本内容 |\n| encoding | string | 是 | - | - | 指定写入文件的字符编码,支持:ascii base64 utf-8 | \n\n\n##### writeFileSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### unlink(options) @unlink\n删除文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UnLinkOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 文件路径，只支持绝对地址 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### unlink 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### unlinkSync(filePath) @unlinksync\nFileSystemManager.unlink 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filePath | string | 是 | - | - | 文件路径，只支持绝对地址 | \n\n\n##### unlinkSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### mkdir(options) @mkdir\n创建目录\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MkDirOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| dirPath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 创建的目录路径 (本地路径) |\n@| recursive | boolean | 是 | - | - | 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在，则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true，将创建 a 目录，再在 a 目录下创建 b 目录，以此类推直至创建 a/b/c 目录下的 d 目录。 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### mkdir 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### mkdirSync(dirPath, recursive) @mkdirsync\nFileSystemManager.mkdir 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| dirPath | string | 是 | - | - | 创建的目录路径 (本地路径) |\n| recursive | boolean | 是 | - | - | 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在，则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true，将创建 a 目录，再在 a 目录下创建 b 目录，以此类推直至创建 a/b/c 目录下的 d 目录。 | \n\n\n##### mkdirSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### rmdir(options) @rmdir\n删除目录\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **RmDirOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| dirPath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要删除的目录路径 (本地路径) |\n@| recursive | boolean | 是 | - | - | 是否递归删除目录。如果为 true，则删除该目录和该目录下的所有子目录以及文件。 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### rmdir 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### rmdirSync(dirPath, recursive) @rmdirsync\nFileSystemManager.rmdir 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| dirPath | string | 是 | - | - | 要删除的目录路径 (本地路径) |\n| recursive | boolean | 是 | - | - | 是否递归删除目录。如果为 true，则删除该目录和该目录下的所有子目录以及文件。 | \n\n\n##### rmdirSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### readdir(options) @readdir\n读取目录内文件列表\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ReadDirOptions](#readdiroptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| dirPath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要读取的目录路径 (本地路径) |\n@| success | (res: [ReadDirSuccessResult](#readdirsuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### ReadDirSuccessResult 的属性值 @readdirsuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| files | Array\\ | 是 | - | - | - |\n\n\n##### readdir 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### readdirSync(dirPath) @readdirsync\nFileSystemManager.readdir 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| dirPath | string | 是 | - | - | 要读取的目录路径 (本地路径) | \n\n##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| Array\\ \\| null | 否 |\n \n\n##### readdirSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### access(options) @access\n判断文件/目录是否存在\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **AccessOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| path | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要删除的目录路径 (本地路径) |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### access 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### accessSync(path) @accesssync\nFileSystemManager.access 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| path | string | 是 | - | - | 要删除的目录路径 (本地路径) | \n\n\n##### accessSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### rename(options) @rename\n重命名文件。可以把文件从 oldPath 移动到 newPath\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **RenameOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| oldPath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 源文件路径，支持本地路径 |\n@| newPath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 新文件路径，支持本地路径 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### rename 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### renameSync(oldPath, newPath) @renamesync\nFileSystemManager.rename 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| oldPath | string | 是 | - | - | 源文件路径，支持本地路径 |\n| newPath | string | 是 | - | - | 新文件路径，支持本地路径 | \n\n\n##### renameSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### copyFile(options) @copyfile\n复制文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **CopyFileOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| srcPath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 源文件路径，支持本地路径 |\n@| destPath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 新文件路径，支持本地路径 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### copyFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### copyFileSync(srcPath, destPath) @copyfilesync\nFileSystemManager.copyFile 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| srcPath | string | 是 | - | - | 源文件路径，支持本地路径 |\n| destPath | string | 是 | - | - | 新文件路径，支持本地路径 | \n\n\n##### copyFileSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### getFileInfo(options) @getfileinfo\n获取该本地临时文件 或 本地缓存文件 信息\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetFileInfoOptions](#getfileinfooptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要读取的文件路径 (本地路径) |\n@| digestAlgorithm | \"md5\" \\| \"sha1\" | 是 | - | - | md5 / sha1 |\n@| success | (res: [GetFileInfoSuccessResult](#getfileinfosuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetFileInfoSuccessResult 的属性值 @getfileinfosuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| digest | string | 是 | - | - | - |\n| size | number | 是 | - | - | - |\n| errMsg | string | 是 | - | - | - |\n\n\n##### getFileInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### stat(options) @stat\n获取文件 Stats 对象\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [StatOptions](#statoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| path | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 文件/目录路径 (本地路径) |\n@| recursive | boolean | 是 | - | - | 是否递归获取目录下的每个文件的 Stats 信息 |\n@| success | (res: [StatSuccessResult](#statsuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### StatSuccessResult 的属性值 @statsuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | - |\n| stats | Array\\<[FileStats](#filestats-values)\\> | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| path | string | 是 | - | - | - |\n@| stats | [Stats](#stats-values) | 是 | - | - | - |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| mode | number | 是 | - | - | 文件的类型和存取的权限，对应 POSIX stat.st_mode
注意android中，文件类型只包含是否是目录与文件，
另外在android中这里的权限指的是当前进程对文件或者文件夹是否有读，写，执行的权限，
这里没有与 POSIX stat.st_mode对应的组，其他人等相关权限的数据返回,只有所有者的相关权限 |\n@@| size | number | 是 | - | - | 文件大小，单位：B，对应 POSIX stat.st_size |\n@@| lastAccessedTime | number | 是 | - | - | 文件最近一次被存取或被执行的时间，UNIX 时间戳，对应 POSIX stat.st_atime
注意：android中由于系统限制无法获取该数据 |\n@@| lastModifiedTime | number | 是 | - | - | 文件最后一次被修改的时间，UNIX 时间戳，对应 POSIX stat.st_mtime |\n\n##### Stats 的方法 @stats-values \n\n##### isDirectory() @isdirectory\n判断当前文件是否一个目录\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n###### isDirectory 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### isFile() @isfile\n判断当前文件是否一个普通文件\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n###### isFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n\n##### stat 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n\n\n#### statSync(path, recursive) @statsync\nFileSystemManager.stat 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| path | string | 是 | - | - | 文件/目录路径 (本地路径) |\n| recursive | boolean | 是 | - | - | 是否递归获取目录下的每个文件的 Stats 信息 | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[FileStats](#filestats-values)\\> |\n \n\n##### statSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### appendFile(options) @appendfile\n在文件结尾追加内容\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **AppendFileOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要追加内容的文件路径 (本地路径) |\n@| encoding | \"ascii\" \\| \"base64\" \\| \"utf-8\" | 是 | - | - | 指定写入文件的字符编码
支持:ascii base64 utf-8 |\n@| data | string | 是 | - | - | 要追加的文本 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### appendFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### appendFileSync(filePath, data, encoding) @appendfilesync\nFileSystemManager.appendFile 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filePath | string | 是 | - | - | 要追加内容的文件路径 (本地路径) |\n| data | string | 是 | - | - | 要追加的文本 |\n| encoding | string | 是 | - | - | 指定写入文件的字符编码支持:ascii base64 utf-8 | \n\n\n##### appendFileSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### saveFile(options) @savefile\n保存临时文件到本地。此接口会移动临时文件，因此调用成功后，tempFilePath 将不可用。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [SaveFileOptions](#savefileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| tempFilePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 临时存储文件路径 (本地路径) |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) \\| null | 否 | - | - | 要存储的文件路径 (本地路径) |\n@| success | (res: [SaveFileSuccessResult](#savefilesuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### SaveFileSuccessResult 的属性值 @savefilesuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| savedFilePath | string | 是 | - | - | 存储后的文件路径 (本地路径) |\n\n\n##### saveFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### saveFileSync(tempFilePath, filePath?) @savefilesync\nFileSystemManager.saveFile 的同步版本\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tempFilePath | string | 是 | - | - | 临时存储文件路径 (本地路径) |\n| filePath | string \\| null | 否 | - | - | 要存储的文件路径 (本地路径) | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| string |\n \n\n##### saveFileSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### removeSavedFile(options) @removesavedfile\n删除该小程序下已保存的本地缓存文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **RemoveSavedFileOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 需要删除的文件路径 (本地路径) |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### removeSavedFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### unzip(options) @unzip\n解压文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UnzipFileOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| zipFilePath | string | 是 | - | - | 源文件路径，支持本地路径, 只可以是 zip 压缩文件 |\n@| targetPath | string | 是 | - | - | 目标目录路径, 支持本地路径 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### unzip 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### getSavedFileList(options) @getsavedfilelist\n获取该已保存的本地缓存文件列表\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetSavedFileListOptions](#getsavedfilelistoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (res: [GetSavedFileListResult](#getsavedfilelistresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetSavedFileListResult 的属性值 @getsavedfilelistresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| fileList | Array\\ | 是 | - | - | - |\n\n\n##### getSavedFileList 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### truncate(options) @truncate\n对文件内容进行截断操作\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **TruncateFileOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要截断的文件路径 (本地路径) |\n@| length | number | 是 | - | - | 截断位置，默认0。如果 length 小于文件长度（字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；
如果 length 大于文件长度，不做处理 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### truncate 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### truncateSync(filePath, length?) @truncatesync\n对文件内容进行截断操作 (truncate 的同步版本)\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filePath | string | 是 | - | - | 要截断的文件路径 (本地路径) |\n| length | number | 否 | - | - | 截断位置，默认0。如果 length 小于文件长度（字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；如果 length 大于文件长度，不做处理 | \n\n\n##### truncateSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### readCompressedFile(options) @readcompressedfile\n读取指定压缩类型的本地文件内容\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ReadCompressedFileOptions](#readcompressedfileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要读取的文件的路径 (本地用户文件或代码包文件)，app-android平台支持代码包文件目录 |\n@| compressionAlgorithm | string | 是 | - | - | 文件压缩类型，目前仅支持 'br'。 |\n@| success | (res: [ReadCompressedFileResult](#readcompressedfileresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### ReadCompressedFileResult 的属性值 @readcompressedfileresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | string | 是 | - | - | - |\n\n\n##### readCompressedFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### readCompressedFileSync(filePath, compressionAlgorithm) @readcompressedfilesync\n同步读取指定压缩类型的本地文件内容\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filePath | string | 是 | - | - | 要读取的文件的路径 (本地用户文件或代码包文件)，app-android平台支持代码包文件目录 |\n| compressionAlgorithm | string | 是 | - | - | 文件压缩类型，目前仅支持 'br'。 | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| string |\n \n\n##### readCompressedFileSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### open(options) @open\n打开文件，返回文件描述符\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [OpenFileOptions](#openfileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要追加内容的文件路径 (本地路径) |\n@| flag | \"a\" \\| \"ax\" \\| \"a+\" \\| \"ax+\" \\| \"r\" \\| \"r+\" \\| \"w\" \\| \"wx\" \\| \"w+\" \\| \"wx\" \\| \"wx+\" | 是 | - | - | 文件系统标志，默认值: 'r' |\n@| success | (res: [OpenFileSuccessResult](#openfilesuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### OpenFileSuccessResult 的属性值 @openfilesuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| fd | string | 是 | - | - | - |\n\n\n##### open 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### openSync(options) @opensync\n同步打开文件，返回文件描述符\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **OpenFileSyncOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要追加内容的文件路径 (本地路径) |\n@| flag | \"a\" \\| \"ax\" \\| \"a+\" \\| \"ax+\" \\| \"r\" \\| \"r+\" \\| \"w\" \\| \"wx\" \\| \"w+\" \\| \"wx\" \\| \"wx+\" | 是 | - | - | 文件系统标志，默认值: 'r' | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| string |\n \n\n##### openSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### write(options) @write\n写入文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [WriteOptions](#writeoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fd | string | 是 | - | - | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |\n@| data | string | 是 | - | - | 写入的内容 |\n@| encoding | \"ascii\" \\| \"base64\" \\| \"utf-8\" | 是 | - | - | 指定写入文件的字符编码
支持:ascii base64 utf-8 |\n@| success | (res: [WriteResult](#writeresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### WriteResult 的属性值 @writeresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| bytesWritten | number | 是 | - | - | 实际被写入到文件中的字节数（注意，被写入的字节数不一定与被写入的字符串字符数相同） |\n\n\n##### write 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### writeSync(options) @writesync\n同步写入文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **WriteSyncOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fd | string | 是 | - | - | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |\n@| data | string | 是 | - | - | 写入的内容 |\n@| encoding | \"ascii\" \\| \"base64\" \\| \"utf-8\" | 是 | - | - | 指定写入文件的字符编码
支持:ascii base64 utf-8 | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [WriteResult](#writeresult-values) |\n \n\n##### writeSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### closeSync(options) @closesync\n同步关闭文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **CloseSyncOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fd | string | 是 | - | - | 需要被关闭的文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 | \n\n\n##### closeSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### fstat(options) @fstat\n获取文件的状态信息\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [FStatOptions](#fstatoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fd | string | 是 | - | - | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |\n@| success | (res: [FStatSuccessResult](#fstatsuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### FStatSuccessResult 的属性值 @fstatsuccessresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| stats | [Stats](#stats-values) | 是 | - | - | Stats 对象，包含了文件的状态信息 |\n\n\n##### fstat 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### fstatSync(options) @fstatsync\n同步获取文件的状态信息\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **FStatSyncOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fd | string | 是 | - | - | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [Stats](#stats-values) |\n \n\n##### fstatSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### ftruncate(options) @ftruncate\n对文件内容进行截断操作\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **FTruncateFileOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fd | string | 是 | - | - | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |\n@| length | number | 是 | - | - | 截断位置，默认0。如果 length 小于文件长度（字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；
如果 length 大于文件长度，不做处理 |\n@| success | (res: [FileManagerSuccessResult](#filemanagersuccessresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### ftruncate 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### ftruncateSync(options) @ftruncatesync\n同步对文件内容进行截断操作\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **FTruncateFileSyncOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fd | string | 是 | - | - | 文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得 |\n@| length | number | 是 | - | - | 截断位置，默认0。如果 length 小于文件长度（字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；
如果 length 大于文件长度，不做处理 | \n\n\n##### ftruncateSync 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n\n#### readZipEntry(options) @readzipentry\n读取压缩包内的文件\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [ReadZipEntryOptions](#readzipentryoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | [string.URIString](/uts/data-type.md#ide-string) | 是 | - | - | 要读取的压缩包的路径 (本地路径)，app-android平台支持代码包文件目录 |\n@| encoding | \"ascii\" \\| \"base64\" \\| \"utf-8\" | 是 | - | - | 统一指定读取文件的字符编码，只在 entries 值为\"all\"时有效。
如果 entries 值为\"all\"且不传 encoding，则以 string 格式读取文件的内容 |\n@| entries | Array\\<**EntryItem**\\> \\| null | 否 | - | - | 要读取的压缩包内的文件列表（当不传入时表示读取压缩包内所有文件） |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| path | string | 是 | - | - | 压缩包内文件路径 |\n@@| encoding | \"ascii\" \\| \"base64\" \\| \"base64\" | 是 | - | - | 指定写入文件的字符编码
支持:ascii base64 utf-8 |\n@| success | (res: [EntriesResult](#entriesresult-values)) => void \\| null | 否 | - | - | 接口调用的回调函数 |\n@| fail | (res: [IFileSystemManagerFail](#ifilesystemmanagerfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### EntriesResult 的属性值 @entriesresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| result | Map\\ | 是 | - | - | 文件路径 |\n\n\n##### readZipEntry 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.13 | x | x |\n\n \n","compatibility":"### getFileSystemManager 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.file.filemanager.getFileSystemManager)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-file-system-manager/get-file-system-manager.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"getUniverifyManager":{"name":"## uni.getUniverifyManager() @getuniverifymanager","description":"获取一键登录管理对象","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [UniverifyManager](#univerifymanager-values) |\n\n#### UniverifyManager 的方法 @univerifymanager-values \n\n#### preLogin(options) @prelogin\n预登录\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [PreLoginOptions](#preloginoptions-values) | 是 | - | - | 预登录参数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | () => void | 否 | - | - | - |\n@| fail | (err: [PreLoginFail](#preloginfail-values)) => void | 否 | - | - | - |\n@| complete | (res: any) => void | 否 | - | - | - | \n\n##### PreLoginFail 的属性值 @preloginfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1000 \\| 1001 \\| 1002 \\| 1004 \\| 4001 \\| 30004 \\| 30005 \\| 30006 | 是 | - | - | 1000 当前应用appid尚未开通uni一键登录
1001 应用所有者账号信息异常，请检查账号一键登录服务是否正常
1002 应用所有者账号信息异常，请检查账号余额是否充足
1004 uni一键登录应用不存在
4001 参数异常
30004 其他错误
30005 预登录失败
30006 一键登录失败 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n\n##### preLogin 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.99 | 4.18 | - |\n\n\n#### login(options) @login\n登录\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [LoginOptions](#loginoptions-values) | 是 | - | - | 登录参数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| univerifyStyle | **UniverifyStyle** | 否 | - | - | 登录页样式 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| fullScreen | boolean | 否 | - | - | 是否全屏 |\n@@| logoPath | string | 否 | - | - | logo路径 |\n@@| backgroundColor | string | 否 | - | - | 登录页背景色 |\n@@| loginBtnText | string | 否 | - | - | 登录按钮文字 |\n@| success | (res: [LoginSuccess](#loginsuccess-values)) => void | 否 | - | - | - |\n@| fail | (err: [LoginFail](#loginfail-values)) => void | 否 | - | - | - |\n@| complete | (res: any) => void | 否 | - | - | - | \n\n##### LoginSuccess 的属性值 @loginsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| openId | string | 是 | - | - | 登录授权唯一标识 |\n| accessToken | string | 是 | - | - | token |\n\n##### LoginFail 的属性值 @loginfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 1000 \\| 1001 \\| 1002 \\| 1004 \\| 4001 \\| 30004 \\| 30005 \\| 30006 | 是 | - | - | 1000 当前应用appid尚未开通uni一键登录
1001 应用所有者账号信息异常，请检查账号一键登录服务是否正常
1002 应用所有者账号信息异常，请检查账号余额是否充足
1004 uni一键登录应用不存在
4001 参数异常
30004 其他错误
30005 预登录失败
30006 一键登录失败 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n\n##### login 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.99 | 4.18 | - |\n\n\n#### close() @close\n关闭登录页\n\n\n##### close 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.99 | 4.18 | - |\n\n\n#### isPreLoginValid() @ispreloginvalid\n预登录是否有效\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n##### isPreLoginValid 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.99 | 4.18 | - |\n\n \n","compatibility":"### getUniverifyManager 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.99 | 4.18 | - |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/univerify.html#univerifymanager)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.login_verify.univerify.getUniverifyManager)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-univerify-manager/get-univerify-manager.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"getFacialRecognitionMetaInfo":{"name":"## uni.getFacialRecognitionMetaInfo() @getfacialrecognitionmetainfo","description":"获取阿里云实人认证meta info","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| string |\n \n","compatibility":"### getFacialRecognitionMetaInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.login_verify.facial-recognition-verify.getFacialRecognitionMetaInfo)\n"},"startFacialRecognitionVerify":{"name":"## uni.startFacialRecognitionVerify(faceStyle) @startfacialrecognitionverify","description":"启动人脸识别","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| faceStyle | [StartFacialRecognitionVerifyOptions](#startfacialrecognitionverifyoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| certifyId | string | 是 | - | - | certifyId 调用实人认证的id |\n@| progressBarColor | string \\| null | 否 | - | - | 活体检测页面的进度条颜色。 |\n@| screenOrientation | \"land\" \\| \"port\" | 否 | \"port\" | | 认证时屏幕方向
- land 横屏
- port 竖屏 |\n@| success | (res: [StartFacialRecognitionVerifySuccess](#startfacialrecognitionverifysuccess-values)) => void \\| null | 否 | - | - | 成功回调 |\n@| fail | (res: [IFacialRecognitionVerifyError](#ifacialrecognitionverifyerror-values)) => void \\| null | 否 | - | - | 失败回调 |\n@| complete | (res: any) => void \\| null | 否 | - | - | 完成回调 | \n\n##### StartFacialRecognitionVerifySuccess 的属性值 @startfacialrecognitionverifysuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | 错误码 |\n| errSubject | string | 是 | - | - | 调用API的名称 |\n| errMsg | string | 是 | - | - | 错误的详细信息 |\n| cause | **SourceError** | 否 | - | - | 错误来源 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| subject | string \\| null | 否 | - | - | 源错误模块名称 |\n@| message | string | 是 | - | - | 源错误描述信息 |\n@| code | number | 是 | - | - | 源错误的错误码 |\n@| name | string | 是 | - | - | - |\n@| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | |\n\n##### IFacialRecognitionVerifyError 的属性值 @ifacialrecognitionverifyerror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 10010 \\| 10012 \\| 10011 \\| 10013 \\| 10020 \\| 10001 \\| 10002 | 是 | - | - | 错误码
- 10001 certifyId 不能为空
- 10002 \"当前设备不支持\"
- 10010 刷脸异常
- 10012 网络异常
- 10011 验证中断
- 10013 刷脸验证失败
- 10020 设备设置时间异常 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### startFacialRecognitionVerify 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.login_verify.facial-recognition-verify.startFacialRecognitionVerify)\n"},"facial-recognition-verify":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/facial-recognition-verify/facial-recognition-verify.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"createRewardedVideoAd":{"name":"## uni.createRewardedVideoAd(option) @createrewardedvideoad","description":"创建激励视频广告对象","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| option | **CreateRewardedVideoAdOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| adpid | string | 是 | - | - | 广告位 id |\n@| urlCallback | **UrlCallbackOptions** \\| null | 否 | - | - | 服务器回调透传参数 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| userId | string \\| null | 否 | - | - | 透传到服务器端的userId |\n@@| extra | string \\| null | 否 | - | - | 透传到服务器端的extra，不推荐设置过于复杂的字符串 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [RewardedVideoAd](#rewardedvideoad-values) |\n\n#### RewardedVideoAd 的方法 @rewardedvideoad-values \n\n#### show() @show\n广告加载成功之后，调用此方法展示广告\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\ |\n \n\n##### show 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### load() @load\n加载广告\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\ |\n \n\n##### load 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### destroy() @destroy\n销毁广告\n\n\n##### destroy 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### onLoad(callback) @onload\n绑定广告 load 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: any) => void | 是 | - | - | - | \n\n\n##### onLoad 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### offLoad(callback) @offload\n解除绑定 load 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: any) => void | 是 | - | - | - | \n\n\n##### offLoad 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### onError(callback) @onerror\n绑定 error 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [IUniAdError](#iuniaderror-values)) => void | 是 | - | - | - | \n\n##### IUniAdError 的属性值 @iuniaderror-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | number | 是 | - | - | 错误码
- -5001 广告位标识adpid为空，请传入有效的adpid
- -5002 无效的广告位标识adpid，请使用正确的adpid
- -5003 广告位未开通广告，请在广告平台申请并确保已审核通过
- -5004 无广告模块，打包时请配置要使用的广告模块
- -5005 广告加载失败，请稍后重试
- -5006 广告已经展示过了，请重新加载
- -5007 广告不可用或已过期，请重新请求
- -5008 广告不可用或已过期，请重新请求
- -5009 广告类型不符，请检查后再试
- -5011 打包或开通的渠道，不支持此类型广告
- -5013 广告播放失败，请重新加载 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n\n\n##### onError 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### offError(callback) @offerror\n解除绑定 error 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [IUniAdError](#iuniaderror-values)) => void | 是 | - | - | - | \n\n\n##### offError 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### onClose(callback) @onclose\n绑定 close 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [VideoAdClose](#videoadclose-values)) => void | 是 | - | - | - | \n\n##### VideoAdClose 的属性值 @videoadclose-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| isEnded | boolean | 是 | - | - | true标识广告播放完毕或者达到发放奖励的条件 |\n\n\n##### onClose 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### offClose(callback) @offclose\n解除绑定 close 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [VideoAdClose](#videoadclose-values)) => void | 是 | - | - | - | \n\n\n##### offClose 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### onAdClicked(callback) @onadclicked\n绑定广告可点击屏幕区域事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: any) => void | 是 | - | - | - | \n\n\n##### onAdClicked 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### onVerify(callback) @onverify\n绑定 verify 事件的监听器\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (result: [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)) => void | 是 | - | - | - | \n\n\n##### onVerify 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n","compatibility":"### createRewardedVideoAd 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.0 | - | - |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.ad.createRewardedVideoAd)\n","example":"### 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/rewarded-video-ad/rewarded-video-ad.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\n\n\n\n\n\n```"},"requestPayment":{"name":"## uni.requestPayment(options) @requestpayment","description":"请求支付","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [RequestPaymentOptions](#requestpaymentoptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| provider | string | 是 | - | - | 支付服务提供商，通过 [uni.getProvider](https://doc.dcloud.net.cn/uni-app-x/api/get-provider.html) 获取,目前支持支付宝支付(alipay),微信支付(wxpay) |\n@| orderInfo | string | 是 | - | - | 订单数据 |\n@| success | (result: [RequestPaymentSuccess](#requestpaymentsuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: [IRequestPaymentFail](#irequestpaymentfail-values)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### RequestPaymentSuccess 的属性值 @requestpaymentsuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | any \\| null | 否 | - | - | |\n\n##### IRequestPaymentFail 的属性值 @irequestpaymentfail-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errCode | 700600 \\| 701100 \\| 701110 \\| 700601 \\| 700602 \\| 700603 \\| 700000 \\| 700604 \\| 700800 \\| 700801 | 是 | - | - | 错误码
- 700600 正在处理中，支付结果未知（有可能已经支付成功），请查询商家订单列表中订单的支付状态
- 701100 订单支付失败。
- 701110 重复请求。
- 700601 用户中途取消。
- 700602 网络连接出错。
- 700603 支付结果未知（有可能已经支付成功），请查询商家订单列表中订单的支付状态。
- 700000 其它支付错误。
- 700604 微信没有安装。
- 700800 没有配置对应的URL Scheme。
- 700801 没有配置对应的universal Link。 |\n| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 |\n| data | any \\| null | 否 | - | - | 错误信息中包含的数据 |\n| cause | [Error](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror) \\| null | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError |\n| errMsg | string | 是 | - | - | - |\n","returnValue":"","compatibility":"### requestPayment 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.02 | 4.18 | x |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/plugins/payment.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.payment.requestPayment)\n","example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/request-payment/request-payment.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\r\n\r\n\r\n\r\n\n\n```"},"createWebviewContext":{"name":"## uni.createWebviewContext(webviewId, component?) @createwebviewcontext","description":"创建 web-view 组件的上下文对象，用于操作 web-view 的行为。","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| webviewId | [string.WebviewIdString](/uts/data-type.md#ide-string) | 是 | - | - | - |\n| component | ComponentPublicInstance \\| null | 否 | - | - | | \n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [WebviewContext](#webviewcontext-values) \\| null | 否 |\n\n#### WebviewContext 的方法 @webviewcontext-values \n\n#### back() @back\n后退到 web-view 组件网页加载历史的上一页，如果不存在上一页则没有任何效果。\n\n\n##### back 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n\n\n#### forward() @forward\n前进到 web-view 组件网页加载历史的下一页，如果不存在下一页则没有任何效果。\n\n\n##### forward 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n\n\n#### reload() @reload\n重新加载 web-view 组件当前页面。\n\n\n##### reload 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n\n\n#### stop() @stop\n停止加载 web-view 组件当前网页，该方法不能阻止已经加载的 html 文档，但是能够阻止未完成的图片及延迟加载的资源。\n\n\n##### stop 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n\n\n#### evalJS(js) @evaljs\n在网页中执行指定的js脚本，在 uvue 页面中可通过此方法向 web-view 组件加载的页面发送数据\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| js | string | 是 | - | - | - | \n\n\n##### evalJS 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | - |\n\n \n","compatibility":"### createWebviewContext 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | x |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.component.create-webview-context)\n"},"createVideoContext":{"name":"## uni.createVideoContext(videoId, component?) @createvideocontext","description":"创建并返回 video 上下文 videoContext 对象","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| videoId | [string.VideoIdString](/uts/data-type.md#ide-string) | 是 | - | - | - |\n| component | ComponentPublicInstance \\| null | 否 | - | - | | \n","returnValue":"### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| [VideoContext](#videocontext-values) \\| null | 否 |\n\n#### VideoContext 的方法 @videocontext-values \n\n#### play() @play\n播放\n\n\n##### play 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n\n\n#### pause() @pause\n暂停\n\n\n##### pause 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n\n\n#### seek(position) @seek\n跳转到指定位置\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| position | number | 是 | - | - | 跳转到指定位置(秒) | \n\n\n##### seek 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n\n\n#### stop() @stop\n停止视频\n\n\n##### stop 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n\n\n#### sendDanmu(danmu) @senddanmu\n发送弹幕\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| danmu | **Danmu** | 是 | - | - | text, color |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| text | string \\| null | 否 | - | - | 弹幕文字 |\n@| color | string \\| null | 否 | - | - | 弹幕颜色 |\n@| time | number \\| null | 否 | - | - | 显示时刻 | \n\n\n##### sendDanmu 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n\n\n#### playbackRate(rate) @playbackrate\n设置倍速播放\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| rate | number | 是 | - | - | , 支持倍率 0.5/0.8/1.0/1.25/1.5 | \n\n\n##### playbackRate 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n\n\n#### requestFullScreen(direction?) @requestfullscreen\n进入全屏\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| direction | **RequestFullScreenOptions** | 否 | - | - | , 0\\|正常竖向, 90\\|屏幕逆时针90度, -90\\|屏幕顺时针90度 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| direction | number \\| null | 否 | - | | direction
- 0: 正常竖向
- 90: 屏幕逆时针90度
- -90: 屏幕顺时针90度 | \n\n\n##### requestFullScreen 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n\n\n#### exitFullScreen() @exitfullscreen\n退出全屏\n\n\n##### exitFullScreen 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9.0 | 4.11 | 4.0 |\n\n \n","compatibility":"### createVideoContext 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| √ | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n- [参见uni-app相关文档](http://uniapp.dcloud.io/api/media/video-context?id=createVideoContext)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.component.create-video-context)\n"},"createMapContext":{"name":"## uni.createMapContext(mapId, currentComponent?) @createmapcontext","description":"创建并返回 map 上下文 mapContext 对象
","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| mapId | string | 是 | - | - | - |\n| currentComponent | ComponentPublicInstance | 否 | - | - | - | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [MapContext](#mapcontext-values) |\n\n#### MapContext 的方法 @mapcontext-values \n\n#### getCenterLocation(options) @getcenterlocation\n获取当前地图中心的经纬度，返回的是 gcj02 坐标系，可以用于 uni.openLocation\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [MapContextGetCenterLocationOptions](#mapcontextgetcenterlocationoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (result: [LocationObject](#locationobject-values)) => void | 否 | - | - | 接口调用成功的回调函数 ，res = { longitude: \"经度\", latitude: \"纬度\"} |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### LocationObject 的属性值 @locationobject-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| latitude | number | 是 | - | - | 纬度，浮点数，范围为-90~90，负数表示南纬 |\n| longitude | number | 是 | - | - | 经度，范围为-180~180，负数表示西经 |\n\n\n##### getCenterLocation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### moveToLocation(options) @movetolocation\n将地图中心移动到当前定位点，需要配合map组件的show-location使用\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextMoveToLocationOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| latitude | number | 否 | - | - | 纬度，浮点数，范围为-90~90，负数表示南纬 |\n@| longitude | number | 否 | - | - | 经度，范围为-180~180，负数表示西经 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### moveToLocation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### translateMarker(options) @translatemarker\n平移marker，带动画\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [MapContextTranslateMarkerOptions](#mapcontexttranslatemarkeroptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| markerId | number | 是 | - | - | 指定marker |\n@| destination | [LocationObject](#locationobject-values) | 是 | - | - | 指定marker移动到的目标点 |\n@| autoRotate | boolean | 否 | - | - | 移动过程中是否自动旋转marker |\n@| rotate | number | 否 | - | - | marker的旋转角度 |\n@| moveWithRotate | boolean | 否 | - | - | 平移和旋转同时进行，默认值false（仅微信小程序2.13.0支持） |\n@| duration | number | 否 | - | - | 动画持续时长，默认值1000ms，平移与旋转分别计算 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### MapContextTranslateMarkerOptions 的方法 @mapcontexttranslatemarkeroptions-values \n\n##### animationEnd(result) @animationend\n动画结束回调函数\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| result | any | 是 | - | - | - | \n\n\n###### animationEnd 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n\n##### translateMarker 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### includePoints(options) @includepoints\n缩放视野展示所有经纬度\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextIncludePointsOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| points | Array\\<[LocationObject](#locationobject-values)\\> | 是 | - | - | 要显示在可视区域内的坐标点列表，[{latitude, longitude}\\] |\n@| padding | Array\\ | 否 | - | - | 坐标点形成的矩形边缘到地图边缘的距离，单位像素。格式为\\[上,右,下,左]安卓上只能识别数组第一项，上下左右的padding一致。开发者工具暂不支持padding参数。 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### includePoints 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### getRegion(options) @getregion\n获取当前地图的视野范围\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [MapContextGetRegionOptions](#mapcontextgetregionoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (result: [MapContextGetRegionResult](#mapcontextgetregionresult-values)) => void | 否 | - | - | 接口调用成功的回调函数，res = {southwest, northeast}，西南角与东北角的经纬度 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### MapContextGetRegionResult 的属性值 @mapcontextgetregionresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| southwest | [LocationObject](#locationobject-values) | 是 | - | - | 西南角的经纬度 |\n| northeast | [LocationObject](#locationobject-values) | 是 | - | - | 东北角的经纬度 |\n\n\n##### getRegion 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### getScale(options) @getscale\n获取当前地图的缩放级别\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [MapContextGetScaleOptions](#mapcontextgetscaleoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| success | (result: [MapContextGetScaleResult](#mapcontextgetscaleresult-values)) => void | 否 | - | - | 接口调用成功的回调函数，res = {scale} |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### MapContextGetScaleResult 的属性值 @mapcontextgetscaleresult-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| scale | number | 是 | - | - | 地图缩放级别 |\n\n\n##### getScale 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### addCustomLayer(options) @addcustomlayer\n添加个性化图层\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextAddCustomLayerOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| layerId | string | 是 | - | - | 个性化图层id |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### addCustomLayer 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### addGroundOverlay(options) @addgroundoverlay\n创建自定义图片图层，图片会随着地图缩放而缩放\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextAddGroundOverlayOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| id | string | 是 | - | - | 图片图层 id |\n@| src | string | 是 | - | - | 图片路径，支持网络图片、临时路径、代码包路径 |\n@| bounds | **Bounds** | 是 | - | - | 图片覆盖的经纬度范围 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| southwest | [LocationObject](#locationobject-values) | 是 | - | - | 西南角的经纬度 |\n@@| northeast | [LocationObject](#locationobject-values) | 是 | - | - | 东北角的经纬度 |\n@| visible | boolean | 否 | - | - | 是否可见 |\n@| zIndex | number | 否 | - | - | 图层绘制顺序 |\n@| opacity | number | 否 | - | - | 图层透明度 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### addGroundOverlay 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### addMarkers(options) @addmarkers\n添加 marker\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextAddMarkersOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| markers | Array\\ | 是 | - | - | 同传入 map 组件的 marker 属性 |\n@| clear | boolean | 是 | - | - | 是否先清空地图上所有 marker |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### addMarkers 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### fromScreenLocation(options) @fromscreenlocation\n获取屏幕上的点对应的经纬度，坐标原点为地图左上角\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextFromScreenLocationOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| x | number | 是 | - | - | x 坐标值 |\n@| y | number | 是 | - | - | y 坐标值 |\n@| success | (result: [LocationObject](#locationobject-values)) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### fromScreenLocation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### initMarkerCluster(options) @initmarkercluster\n初始化点聚合的配置，未调用时采用默认配置\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextInitMarkerClusterOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| enableDefaultStyle | boolean | 是 | - | - | 启用默认的聚合样式 |\n@| zoomOnClick | boolean | 是 | - | - | 点击已经聚合的标记点时是否实现聚合分离 |\n@| gridSize | number | 是 | - | - | 聚合算法的可聚合距离，即距离小于该值的点会聚合至一起，以像素为单位 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### initMarkerCluster 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### moveAlong(options) @movealong\n沿指定路径移动 marker，用于轨迹回放等场景。动画完成时触发回调事件，若动画进行中，对同一 marker 再次调用 moveAlong 方法，前一次的动画将被打断。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextMoveAlongOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| markerId | number | 是 | - | - | 指定 marker |\n@| path | Array\\<[LocationObject](#locationobject-values)\\> | 是 | - | - | 移动路径的坐标串，坐标点格式 {longitude, latitude} |\n@| autoRotate | boolean | 否 | - | - | 根据路径方向自动改变 marker 的旋转角度 |\n@| duration | number | 是 | - | - | 平滑移动的时间 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### moveAlong 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### openMapApp(options) @openmapapp\n拉起地图APP选择导航。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextOpenMapAppOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| destination | string | 是 | - | - | 目的地名称 |\n@| latitude | number | 是 | - | - | 目的地纬度 |\n@| longitude | number | 是 | - | - | 目的地经度 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### openMapApp 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### removeCustomLayer(options) @removecustomlayer\n移除个性化图层\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextRemoveCustomLayerOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| layerId | string | 是 | - | - | 个性化图层id |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### removeCustomLayer 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### removeGroundOverlay(options) @removegroundoverlay\n移除自定义图片图层\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextRemoveGroundOverlayOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| id | string | 是 | - | - | 图片图层 id |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### removeGroundOverlay 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### removeMarkers(options) @removemarkers\n移除 marker\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextRemoveMarkersOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| markerIds | Array\\ | 是 | - | - | 要被删除的marker的id属性组成的数组 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### removeMarkers 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### setCenterOffset(options) @setcenteroffset\n设置地图中心点偏移，向后向下为增长，屏幕比例范围(0.25~0.75)，默认偏移为[0.5, 0.5\\]\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextSetCenterOffsetOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| offset | Array\\ | 是 | - | - | 偏移量，两位数组 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### setCenterOffset 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### toScreenLocation(options) @toscreenlocation\n获取经纬度对应的屏幕坐标，坐标原点为地图左上角。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextToScreenLocationOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| latitude | number | 是 | - | - | 纬度 |\n@| longitude | number | 是 | - | - | 经度 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### toScreenLocation 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### updateGroundOverlay(options) @updategroundoverlay\n更新自定义图片图层。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **MapContextUpdateGroundOverlayOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| id | string | 是 | - | - | 图片图层 id |\n@| src | string | 是 | - | - | 图片路径，支持网络图片、临时路径、代码包路径 |\n@| bounds | [Bounds](#bounds-values) | 是 | - | - | 图片路径，支持网络图片、临时路径、代码包路径 |\n@| visible | boolean | 否 | - | - | 是否可见 |\n@| zIndex | number | 否 | - | - | 图层绘制顺序 |\n@| opacity | number | 否 | - | - | 图层透明度 |\n@| success | (result: any) => void | 否 | - | - | 接口调用成功的回调函数 |\n@| fail | (result: any) => void | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n\n##### updateGroundOverlay 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### on(event, callback) @on\n监听地图事件。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| event | \"markerClusterCreate\" \\| \"markerClusterClick\" | 是 | - | - | - |\n| callback | (args?: Array\\) => any | 是 | - | - | - | \n\n\n##### on 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### $getAppMap() @$getappmap\n获取原生地图对象 plus.maps.Map\n\n##### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n##### $getAppMap 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n","compatibility":"### createMapContext 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |\n","tutorial":"\n### 参见\n- [createMapContext](https://doc.dcloud.net.cn/uni-app-x/api/create-map-context.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.component.create-map-context)\n"},"getProvider":{"name":"## uni.getProvider(options) @getprovider","description":"获取服务供应商","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [GetProviderOptions](#getprovideroptions-values) | 是 | - | - | |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| service | string | 是 | - | - | 服务类型，可取值“payment”
- payment: 支付 (Alipay、Wxpay) |\n@| success | (result: [GetProviderSuccess](#getprovidersuccess-values)) => void \\| null | 否 | - | - | 接口调用成功的回调 |\n@| fail | (result: [UniError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#unierror)) => void \\| null | 否 | - | - | 接口调用失败的回调函数 |\n@| complete | (result: any) => void \\| null | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） | \n\n##### GetProviderSuccess 的属性值 @getprovidersuccess-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| service | string | 是 | - | - | 服务类型
- payment: 支付 |\n| provider | Array\\ | 是 | - | - | 得到的服务供应商 |\n| providers | Array\\<**UniProvider**\\> | 是 | - | | 得到的服务供应商服务对象 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| id | string | 是 | - | - | 服务供应商标识 |\n@| description | string | 是 | - | - | 服务供应商描述 |\n@| isAppExist | boolean | 是 | - | - | 判断服务供应商依赖的App是否安装 |\n| errMsg | string | 是 | - | - | 描述信息 |\n","returnValue":"","compatibility":"### getProvider 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.11 | 4.18 | 4.05 |\n","tutorial":"\n### 参见\n- [getProvider](https://doc.dcloud.net.cn/uni-app-x/api/get-provider.html)\n\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.tripartite.get-provider)\n"},"get-provider":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/get-provider/get-provider.uvue) \n >\n> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 \n```uvue\n\r\n\r\n\r\n\r\n\n\n```"},"general_type":{"name":"## 通用类型\n","param":"### GeneralCallbackResult \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| errMsg | string | 是 | - | - | 错误信息 |\n"}} \ No newline at end of file diff --git a/docs/.vuepress/utils/utsJson.json b/docs/.vuepress/utils/utsJson.json index 8b74455ab9520d5f69583f097bf780742db1fd00..c3148ad3b34016344bb5d72f53fc76f1f8f572ad 100644 --- a/docs/.vuepress/utils/utsJson.json +++ b/docs/.vuepress/utils/utsJson.json @@ -1 +1 @@ -{"String":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.String)","length":{"name":"### length","description":"\n返回字符串的 UTF-16 码元长度。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"toString":{"name":"### toString()","description":"\n返回一个字符串，表示指定的字符串。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | String 包装对象的字符串值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"charAt":{"name":"### charAt(pos)","description":"\n返回一个由给定索引处的单个 UTF-16 码元构成的新字符串。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| pos | number | 是 | - | - | 要返回的字符的索引，从零开始。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个字符串，该字符串表示指定 index 处的字符（恰好是一个 UTF-16 码元）。如果 index 超出了 0 – str.length - 1 的范围，charAt() 将返回一个空字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"toCharArray":{"name":"### toCharArray()","description":"\n返回包含此字符串的字符的\\[kotlin.CharArray]","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| CharArray | 字符数组 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | x | √ | x | x |\n","itemType":"method"},"charCodeAt":{"name":"### charCodeAt(index)","description":"\n返回 0 到 65535 之间的整数，表示给定索引处的 UTF-16 代码单元","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| index | number | 是 | - | - | 一个大于等于 0，小于字符串长度的整数。如果不是一个数值，则默认为 0。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 指定 index 处字符的 UTF-16 代码单元值的一个数字；如果 index 超出范围，charCodeAt() 返回 NaN。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"concat":{"name":"### concat(...strings)","description":"\n将字符串参数连接到调用的字符串，并返回一个新的字符串。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| strings | string[\\] | 是 | - | - | T要连接到 str 的一个或多个字符串。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个包含所提供的多个字符串文本组合的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"indexOf":{"name":"### indexOf(searchString, position?)","description":"\n在字符串中搜索指定子字符串，并返回其第一次出现的位置索引。它可以接受一个可选的参数指定搜索的起始位置，如果找到了指定的子字符串，则返回的位置索引大于或等于指定的数字。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchString | string | 是 | - | - | 要搜索的子字符串。 |\n| position | number | 是 | - | - | 该方法返回指定子字符串在大于或等于 position 位置的第一次出现的索引，默认为 0。如果 position 大于调用字符串的长度，则该方法根本不搜索调用字符串。如果 position 小于零，该方法的行为就像 position 为 0 时一样。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 查找的字符串 searchValue 的第一次出现的索引，如果没有找到，则返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"lastIndexOf":{"name":"### lastIndexOf(searchString, position?)","description":"\n搜索该字符串并返回指定子字符串最后一次出现的索引。它可以接受一个可选的起始位置参数，并返回指定子字符串在小于或等于指定数字的索引中的最后一次出现的位置。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchString | string | 是 | - | - | 要搜索的子字符串。 |\n| position | number | 是 | - | - | 该方法返回指定子字符串在小于或等于 position 的位置中的最后一次出现的索引，默认为 +Infinity。如果 position 大于调用字符串的长度，则该方法将搜索整个字符串。如果 position 小于 0，则行为与 0 相同，即该方法只在索引 0 处查找指定的子字符串。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 如果找到了 searchString，则返回最后一次出现的索引，否则返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"localeCompare":{"name":"### localeCompare(that)","description":"\n返回一个数字，表示参考字符串在排序顺序中是在给定字符串之前、之后还是与之相同。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| that | string | 是 | - | - | 与 referenceStr 进行比较的字符串。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个数字表示 referenceStr 在排序中是否位于 compareString 的前面、后面或二者相同。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"match":{"name":"### match(regexp)","description":"\nmatch() 方法检索字符串与正则表达式进行匹配的结果。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| regexp | string \\| RegExp | 是 | - | - | 一个正则表达式对象或者任何具有 Symbol.match 方法的对象。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| RegExpMatchArray \\| null | 一个 Array，其内容取决于是否存在全局（g）标志，如果没有匹配，则返回 null。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"replace":{"name":"### replace(searchValue, replaceValue)","description":"\n返回一个由替换值（replacement）替换部分或所有的模式（pattern）匹配项后的新字符串。模式可以是一个字符串或者一个正则表达式。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchValue | string \\| RegExp | 是 | - | - | RegExp: 一个RegExp 对象或者其字面量。该正则所匹配的内容会被第二个参数的返回值替换掉。string: 一个将被 newSubStr 替换的 字符串。其被视为一整个字符串，而不是一个正则表达式。仅第一个匹配项会被替换。 |\n| replaceValue | string | 是 | - | - | 用于替换掉第一个参数在原字符串中的匹配部分的字符串。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个部分或全部匹配由替代模式所取代的新的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"replace_1":{"name":"### replace(searchValue, replacer)","description":"\n返回一个由替换值（replacement）替换部分或所有的模式（pattern）匹配项后的新字符串。模式可以是一个字符串或者一个正则表达式，替换值是一个每次匹配都要调用的回调函数。如果pattern是字符串，则仅替换第一个匹配项。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchValue | string \\| RegExp | 是 | - | - | RegExp: 一个RegExp 对象或者其字面量。该正则所匹配的内容会被第二个参数的返回值替换掉。string: 一个将被 newSubStr 替换的 字符串。其被视为一整个字符串，而不是一个正则表达式。仅第一个匹配项会被替换。 |\n| replacer | (substring: string, args?: Array\\) => string | 是 | - | - | 一个用来创建新子字符串的函数，该函数的返回值将替换掉第一个参数匹配到的结果。在iOS中replacer的第二个参数是字符串数组而非可变参数。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个部分或全部匹配由替代模式所取代的新的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"search":{"name":"### search(regexp)","description":"\nsearch() 方法执行正则表达式和 String 对象之间的一个搜索匹配。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| regexp | string \\| RegExp | 是 | - | - | 一个正则表达式（regular expression）对象。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 如果匹配成功，则 search() 返回正则表达式在字符串中首次匹配项的索引;否则，返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"slice":{"name":"### slice(start?, end?)","description":"\nslice() 方法提取某个字符串的一部分，并返回一个新的字符串，且不会改动原字符串。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| start | number | 是 | - | - | 可选。从该索引（以 0 为基数）处开始提取原字符串中的字符。如果值为负数，会被当做 strLength + beginIndex 看待，这里的strLength 是字符串的长度（例如，如果 beginIndex 是 -3 则看作是：strLength - 3） |\n| end | number | 是 | - | - | 可选。在该索引（以 0 为基数）处结束提取字符串。如果省略该参数，slice() 会一直提取到字符串末尾。如果该参数为负数，则被看作是 strLength + endIndex，这里的 strLength 就是字符串的长度 (例如，如果 endIndex 是 -3，则是，strLength - 3)。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个从原字符串中提取出来的新字符串 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"split":{"name":"### split(separator, limit?)","description":"\nsplit() 方法接受一个模式，通过搜索模式将字符串分割成一个有序的子串列表，将这些子串放入一个数组，并返回该数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| separator | string \\| RegExp | 是 | - | - | 描述每个分割应该发生在哪里的模式。 |\n| limit | number | 是 | - | - | 一个非负整数，指定数组中包含的子字符串的数量限制。当提供此参数时，split 方法会在指定 separator 每次出现时分割该字符串，但在已经有 limit 个元素时停止分割。任何剩余的文本都不会包含在数组中。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string[\\] | 在给定字符串中出现 separator 的每一个点上进行分割而成的字符串数组。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"substring":{"name":"### substring(start, end?)","description":"\n返回一个字符串在开始索引到结束索引之间的一个子集，或从开始索引直到字符串的末尾的一个子集。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| start | number | 是 | - | - | 要截取的第一个字符的索引，该索引位置的字符作为返回的字符串的首字母。 |\n| end | number | 是 | - | - | 可选。一个 0 到字符串长度之间的整数，以该数字为索引的字符不包含在截取的字符串内。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含给定字符串的指定部分的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"toLowerCase":{"name":"### toLowerCase()","description":"toLowerCase() 会将调用该方法的字符串值转为小写形式，并返回。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个新的字符串，表示转换为小写的调用字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"toLocaleLowerCase":{"name":"### toLocaleLowerCase(locales?)","description":"\n根据任何指定区域语言环境设置的大小写映射，返回调用字符串被转换为小写的格式。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| locales | string \\| string[\\] | 是 | - | - | 可选。指明要转换成小写格式的特定语言区域。如果以一个数组 Array 形式给出多个 locales, 最合适的地区将被选出来应用。默认的 locale 是主机环境的当前区域 (locale) 设置。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 根据任何特定于语言环境的案例映射规则将被调用字串转换成小写格式的一个新字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"toUpperCase":{"name":"### toUpperCase()","description":"\n将调用该方法的字符串转为大写形式并返回（如果调用该方法的值不是字符串类型会被强制转换）。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个新的字符串，表示转换为大写的调用字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"toLocaleUpperCase":{"name":"### toLocaleUpperCase(locales?)","description":"\n根据本地主机语言环境把字符串转换为大写格式，并返回转换后的字符串。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| locales | string \\| string[\\] | 是 | - | - | locales参数指示要用于根据任何特定于语言环境的大小写映射转换为大写的语言环境。如果Array中给出了多个区域设置，则使用最佳可用区域设置。默认语言环境是主机环境的当前语言环境。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 根据任何特定于语言环境的大小写映射，表示转换为大写的调用字符串的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"trim":{"name":"### trim()","description":"\n从字符串的两端清除空格，返回一个新的字符串，而不修改原始字符串。此上下文中的空格是指所有的空白字符（空格、tab、不换行空格等）以及所有行终止符字符（如 LF、CR 等）。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个表示 str 去掉了开头和结尾的空白字符后的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"substr":{"name":"### substr(from, length?)","description":"\n返回一个字符串中从指定位置开始到指定字符数的字符。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| from | number | 是 | - | - | 开始提取字符的位置。如果为负值，则被看作 strLength + start，其中 strLength 为字符串的长度（例如，如果 start 为 -3，则被看作 strLength + (-3)）。 |\n| length | number | 是 | - | - | 可选。提取的字符数。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个字符串中从指定位置开始到指定字符数的字符。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"valueOf":{"name":"### valueOf()","description":"返回 String 对象的原始值","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | String 对象的原始值 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"padStart":{"name":"### padStart(targetLength, padString?)","description":"\n用另一个字符串填充当前字符串（如果需要会重复填充），直到达到给定的长度。填充是从当前字符串的开头开始的。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| targetLength | number | 是 | - | - | 当前 str 填充后的长度。如果该值小于或等于 str.length，则会直接返回当前 str。 |\n| padString | string | 是 | - | - | 可选。用于填充当前 str 的字符串。如果 padString 太长，无法适应 targetLength，则会从末尾被截断。默认值为“ ”字符（U+0020）。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 在开头填充 padString 直到达到给定的 targetLength 所形成的 String。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"padEnd":{"name":"### padEnd(targetLength, padString?)","description":"\n将当前字符串从末尾开始填充给定的字符串（如果需要会重复填充），直到达到给定的长度。填充是从当前字符串的末尾开始的。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| targetLength | number | 是 | - | - | 当前 str 填充后的长度。如果该值小于或等于 str.length，则会直接返回当前 str。 |\n| padString | string | 是 | - | - | 可选。用于填充当前 str 的字符串。如果 padString 太长，无法适应 targetLength，则会被截断。默认值为“ ”字符（U+0020）。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 在开头填充 padString 直到达到给定的 targetLength 所形成的 String。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"codePointAt":{"name":"### codePointAt(pos)","description":"\n返回一个小于 1114112 (0x110000) 的非负整数 Number，它是 UTF-16 编码的代码点的代码点值，该代码点始于将此对象转换为字符串而产生的字符串中位置 pos 处的字符串元素。\n如果该位置没有元素，则结果未定义。\n如果有效的 UTF-16 代理项对不是从 pos 开始，则结果是 pos 处的代码单元。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| pos | number | 是 | - | - | 这个字符串中需要转码的元素的位置。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number \\| null | 返回值是在字符串中的给定索引的编码单元体现的数字，如果在索引处没找到元素则返回 null。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"includes":{"name":"### includes(searchString, position?)","description":"\n如果 searchString 作为此对象转换为 String 的结果的子字符串出现在大于或等于position的一个或多个位置，则返回 true；否则，返回 false。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchString | string | 是 | - | - | 要在 str 中搜索的字符串。不能是正则表达式。 |\n| position | number | 是 | - | - | 在字符串中开始搜索 searchString 的位置。（默认为 0。） | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果在给定的字符串中找到了要搜索的字符串（包括 searchString 为空字符串的情况），则返回 true，否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"endsWith":{"name":"### endsWith(searchString, endPosition?)","description":"\nendsWith() 方法用于判断一个字符串是否以指定字符串结尾，如果是则返回 true，否则返回 false。该方法区分大小写。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchString | string | 是 | - | - | 要搜索的作为结尾的字符串，不能是正则表达式。所有非正则表达式的值都会被强制转换为字符串。 |\n| endPosition | number | 是 | - | - | 可选，预期找到 searchString 的末尾位置（即 searchString 最后一个字符的索引加 1）。默认为 str.length。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果被检索字符串的末尾出现了指定的字符串（包括 searchString 为空字符串的情况），则返回 true；否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"normalize":{"name":"### normalize(form)","description":"\nnormalize() 方法会按照指定的一种 Unicode 正规形式将当前字符串规范化。（如果该值不是字符串，则首先将其转换为一个字符串）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| form | \"NFC\" \\| \"NFD\" \\| \"NFKC\" \\| \"NFKD\" | 是 | - | - | 四种 Unicode 正规形式（Unicode Normalization Form）\"NFC\"、\"NFD\"、\"NFKC\"，或 \"NFKD\" 其中的一个，默认值为 \"NFC\"。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 含有给定字符串的 Unicode 规范化形式的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"normalize_1":{"name":"### normalize(form?)","description":"\nnormalize() 方法会按照指定的一种 Unicode 正规形式将当前字符串规范化。（如果该值不是字符串，则首先将其转换为一个字符串）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| form | string | 是 | - | - | 四种 Unicode 正规形式（Unicode Normalization Form）\"NFC\"、\"NFD\"、\"NFKC\"，或 \"NFKD\" 其中的一个，默认值为 \"NFC\"。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 含有给定字符串的 Unicode 规范化形式的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"repeat":{"name":"### repeat(count)","description":"\nrepeat() 构造并返回一个新字符串，该字符串包含被连接在一起的指定数量的字符串的副本。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| count | number | 是 | - | - | 介于 0 和 +Infinity 之间的整数。表示在新构造的字符串中重复了多少遍原字符串。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含指定字符串的指定数量副本的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"startsWith":{"name":"### startsWith(searchString, position?)","description":"\nstartsWith() 方法用来判断当前字符串是否以另外一个给定的子字符串开头，并根据判断结果返回 true 或 false。这个方法区分大小写。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchString | string | 是 | - | - | 要搜索的子字符串。 |\n| position | number | 是 | - | - | 在 str 中搜索 searchString 的开始位置，默认值为 0。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果在字符串的开头找到了给定的字符则返回 true；否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"anchor":{"name":"### anchor(name)","description":"\nanchor() 方法创建一个 \\ HTML 锚元素，被用作超文本靶标（hypertext target）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | 一个字符串，表示被创建的标签的 name 属性。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含 \\ HTML 元素的一个字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"big":{"name":"### big()","description":"\n创建一个使字符串显示大号字体的\\标签。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 带有 \\标签的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"blink":{"name":"### blink()","description":"\nblink() 方法创建一个字符串，其在 \\str\\ 中嵌入字符串，这使得字符串在旧版浏览器中闪烁。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含 \\ HTML 元素的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"bold":{"name":"### bold()","description":"\nbold() 方法会创建 HTML 元素“b”，并将字符串加粗展示。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含 HTML 元素 \\ 的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"fixed":{"name":"### fixed()","description":"\nfixed() 方法创建了一个 \\ 标签元素将字符串包裹起来，从而让这个字符串里面的内容具有固定间距。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个表示 \\ HTML 元素的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"fontcolor":{"name":"### fontcolor(color)","description":"\n创建一个\\的 HTML 元素让字符串被显示成指定的字体颜色。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| color | string | 是 | - | - | 代表颜色的一个字符串，可以是三个一组的十六进制的 RGB 值，也可以是一个颜色名称的字符串字面量. | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个包含一个\\ HTML 元素的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"fontsize":{"name":"### fontsize(size)","description":"\n返回一个' \\ ' HTML元素并设置size属性值","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| size | number | 是 | - | - | 1到7之间的整数。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含\\ HTML元素的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"fontsize_1":{"name":"### fontsize(size)","description":"\n返回一个' \\ ' HTML元素并设置size属性值","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| size | string | 是 | - | - | 表示1到7之间的有符号整数的字符串。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含\\ HTML元素的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"italics":{"name":"### italics()","description":"\nitalics()方法创建一个\\ HTML元素，使字符串变为斜体。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个\\ HTML元素，使字符串变为斜体。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"link":{"name":"### link(url)","description":"\nlink() 方法创建一个 HTML 元素 \\ ，用该字符串作为超链接的显示文本，参数作为指向另一个 URL 的超链接。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| url | string | 是 | - | - | 任何能够指定 a 标签的 href 属性的字符串；它应当是有效的 URL（相对或绝对），任何 & 字符将会被转义为 &，任何 \" 字符将会被转义为 "。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个带有一个 HTML 元素 \\ 的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"small":{"name":"### small()","description":"\nsmall() 方法的作用是创建一个使字符串显示小号字体的 \\ 标签。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 带有 \\ 标签的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"strike":{"name":"### strike()","description":"\nstrike()方法创建\\ HTML 元素，使字符串展示为被删除的文本。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含\\ HTML 元素的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"sub":{"name":"### sub()","description":"\nsub()方法创建一个 \\ HTML 元素，使字符串展示为下标。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含\\ HTML 元素的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"sup":{"name":"### sup()","description":"\nsup()方法创建 一个\\HTML 元素，使字符串显示为上标。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含\\ HTML 元素的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"at":{"name":"### at(index)","description":"\n方法接受一个整数值，并返回一个新的 String，该字符串由位于指定偏移量处的单个 UTF-16 码元组成","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| index | number | 是 | - | - | 字符指定偏移量处，允许正整数和负整数，负整数从字符串中的最后一个字符开始倒数。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string \\| null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"fromCharCode":{"name":"### fromCharCode(...codes)","description":"","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| codes | number[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | - | √ | 3.9+ | - |\n","itemType":"method"}},"Number":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Number)","MAX_VALUE":{"name":"### MAX_VALUE","description":"\n在 JavaScript 里所能表示的最大数值。无限接近于 1.79E+308。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"MIN_VALUE":{"name":"### MIN_VALUE","description":"\n表示在 JavaScript 中所能表示的最小的正值。 无限接近于 5.00E-324。\n","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"NaN":{"name":"### NaN","description":"\n表示“非数字”（Not-A-Number）。和 NaN 相同。\n在相等比较中，NaN不等于任何值，包括它自己。要测试一个值是否等于NaN，使用isNaN函数。\n","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"NEGATIVE_INFINITY":{"name":"### NEGATIVE_INFINITY","description":"\n表示负无穷大。\nNumber.NEGATIVE_INFINITY 的值和全局对象的 Infinity 属性的负值相同。\n","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"POSITIVE_INFINITY":{"name":"### POSITIVE_INFINITY","description":"\n表示正无穷大。\nNumber.POSITIVE_INFINITY 的值同全局对象 Infinity 属性的值相同。\n","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"toString":{"name":"### toString(radix?)","description":"\n返回指定 Number 对象的字符串表示形式。如果转换的基数大于 10，则会使用字母来表示大于 9 的数字，比如基数为 16 的情况，则使用 a 到 f 的字母来表示 10 到 15。如果基数没有指定，则使用 10。如果对象是负数，则会保留负号。即使 radix 是 2 时也是如此：返回的字符串包含一个负号（-）前缀和正数的二进制表示，不是 数值的二进制补码。进行数字到字符串的转换时，建议用小括号将要转换的目标括起来，防止出错。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| radix | number | 是 | - | - | 指定要用于数字到字符串的转换的基数 (从 2 到 36)。如果未指定 radix 参数，则默认值为 10。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"toFixed":{"name":"### toFixed(fractionDigits?)","description":"\n使用定点表示法来格式化一个数值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| fractionDigits | number | 是 | - | - | 小数点后数字的个数；介于 0 到 20（包括）之间，实现环境可能支持更大范围。如果忽略该参数，则默认为 0。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 使用定点表示法表示给定数字的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"toExponential":{"name":"### toExponential(fractionDigits?)","description":"\n以指数表示法返回该数值字符串表示形式。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| fractionDigits | number | 是 | - | - | 可选。一个整数，用来指定小数点后有几位数字。默认情况下用尽可能多的位数来显示数字。如果 fractionDigits 太小或太大将会抛出该错误。必须介于 0 和 20（包括 20）之间。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个用幂的形式 (科学记数法) 来表示Number 对象的字符串。小数点后以 fractionDigits 提供的值来四舍五入。如果 fractionDigits 参数被忽略了，小数点后的将尽可能用最多的位数来表示该数值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"toPrecision":{"name":"### toPrecision(precision?)","description":"\n以指定的精度返回该数值对象的字符串表示。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| precision | number | 是 | - | - | 一个用来指定有效数个数的整数。 必须介于 1 到 21 之间。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 以定点表示法或指数表示法表示的一个数值对象的字符串表示，四舍五入到 precision 参数指定的显示数字位数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"valueOf":{"name":"### valueOf()","description":"\n返回一个被 Number 对象包装的原始值。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 表示指定 Number 对象的原始值的数字。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"toInt":{"name":"### toInt()","description":"\n返回一个Int 值","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Int | 返回 number 对应的 Int 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | x | √ | √ | x |\n","itemType":"method"},"toFloat":{"name":"### toFloat()","description":"\n返回一个Float 值","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Float | 返回 number 对应的 Float 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | x | √ | √ | x |\n","itemType":"method"},"toDouble":{"name":"### toDouble()","description":"\n返回一个 Double 值","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Double | 返回 number 对应的 Double 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | x | √ | √ | x |\n","itemType":"method"},"toInt64":{"name":"### toInt64()","description":"\n返回一个 Int64 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Int64 | 返回 number 对应的 Int64 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | x | x | 3.9+ | x |\n","itemType":"method"},"toInt32":{"name":"### toInt32()","description":"\n返回一个 Int32 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Int32 | 返回 number 对应的 Int32 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | x | x | 3.9+ | x |\n","itemType":"method"},"toInt16":{"name":"### toInt16()","description":"\n返回一个 Int16 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Int16 | 返回 number 对应的 Int16 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | x | x | 3.9+ | x |\n","itemType":"method"},"toInt8":{"name":"### toInt8()","description":"\n返回一个 Int8 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Int8 | 返回 number 对应的 Int8 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | x | x | 3.9+ | x |\n","itemType":"method"},"toUInt":{"name":"### toUInt()","description":"\n返回一个 UInt 值","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UInt | 返回 number 对应的 UInt 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | x | √ | 3.9+ | x |\n","itemType":"method"},"toUInt64":{"name":"### toUInt64()","description":"\n返回一个 UInt64 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UInt64 | 返回 number 对应的 UInt64 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | x | x | 3.9+ | x |\n","itemType":"method"},"toUInt32":{"name":"### toUInt32()","description":"\n返回一个 UInt32 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UInt32 | 返回 number 对应的 UInt32 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | x | x | 3.9+ | x |\n","itemType":"method"},"toUInt16":{"name":"### toUInt16()","description":"\n返回一个 UInt16 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UInt16 | 返回 number 对应的 UInt16 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | x | x | 3.9+ | x |\n","itemType":"method"},"toUInt8":{"name":"### toUInt8()","description":"\n返回一个 UInt8 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UInt8 | 返回 number 对应的 UInt8 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | x | x | 3.9+ | x |\n","itemType":"method"},"toByte":{"name":"### toByte()","description":"\n将当前的Number数据转换为Byte表示，如果超出Byte最大值表示范围，会得到溢出后余数表示, app-andorid平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Byte | 返回 number 对应的 Byte 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | x | √ | x | x |\n","itemType":"method"},"toLong":{"name":"### toLong()","description":"\n将当前的Number数据转换为Long表示，如果超出Long最大值表示范围，会得到溢出后余数表示, app-andorid平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Long | 返回 number 对应的 Long 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | x | √ | x | x |\n","itemType":"method"},"toShort":{"name":"### toShort()","description":"\n将当前的Number数据转换为Short表示，如果超出Short最大值表示范围，会得到溢出后余数表示, app-andorid平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Short | 返回 number 对应的 Short 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | x | √ | x | x |\n","itemType":"method"},"toUShort":{"name":"### toUShort()","description":"\n将当前的 Number 数据转换为 UShort 表示，如果超出 UShort 最大值表示范围，会得到溢出后余数表示, app-andorid平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UShort | 返回 number 对应的 UShort 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | x | √ | x | x |\n","itemType":"method"},"toULong":{"name":"### toULong()","description":"\n将当前的 Number 数据转换为 ULong 表示，如果超出 ULong 最大值表示范围，会得到溢出后余数表示, app-andorid平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| ULong | 返回 number 对应的 ULong 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | x | √ | x | x |\n","itemType":"method"},"from":{"name":"### from(value)","description":"\n通过 Int \\| Float \\| Double \\| Int64 \\| Int32 \\| Int16 \\| Int8 \\| UInt \\| UInt64 \\| UInt32 \\| UInt16 \\| UInt8 \\| Byte \\| Short \\| Long 类型创建一个 number","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | Int \\| Float \\| Double \\| Int64 \\| Int32 \\| Int16 \\| Int8 \\| UInt \\| UInt64 \\| UInt32 \\| UInt16 \\| UInt8 \\| Byte \\| Short \\| Long | 是 | - | - | 必填。一个 Swfit 或者 Kottlin 专有数字类型的值。其中 Swift 平台 支持 Int, Float, Double, Int64, Int32, Int16, Int8, UInt, UInt64, UInt32, UInt16, UInt8。Kottlin 平台支持 Int, Float, Double, Byte, Short, Long | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回 number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | x | 3.9+ | 3.9+ | x |\n","itemType":"method"}},"Math":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Math)","E":{"name":"### E","description":"\nMath.E 属性表示自然对数的底数（或称为基数），e，约等于 2.718。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"LN10":{"name":"### LN10","description":"\nMath.LN10 属性表示 10 的自然对数，约为 2.302\n","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"LN2":{"name":"### LN2","description":"\nMath.LN2 属性表示 2 的自然对数，约为 0.693","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"LOG2E":{"name":"### LOG2E","description":"\nMath.LOG2E 属性表示以 2 为底数，e 的对数，约为 1.442","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"LOG10E":{"name":"### LOG10E","description":"\nMath.LOG10E 属性表示以 10 为底数，e 的对数，约为 0.434","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"PI":{"name":"### PI","description":"\nMath.PI 表示一个圆的周长与直径的比例，约为 3.14159","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"SQRT1_2":{"name":"### SQRT1_2","description":"\nMath.SQRT1_2 属性表示 1/2 的平方根，约为 0.707","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"SQRT2":{"name":"### SQRT2","description":"\nMath.SQRT2 属性表示 2 的平方根，约为 1.414","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"abs":{"name":"### abs(x)","description":"\nRMath.abs(x) 函数返回一个数字的绝对值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数字 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | x 的绝对值。如果 x 是负数（包括 -0），则返回 -x。否则，返回 x | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"acos":{"name":"### acos(x)","description":"\nMath.acos() 返回一个数的反余弦值（单位为弧度）","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值. | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"asin":{"name":"### asin(x)","description":"\nMath.asin() 方法返回一个数值的反正弦（单位为弧度）","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"atan":{"name":"### atan(x)","description":"\nMath.atan() 函数返回一个数值的反正切（以弧度为单位）","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"atan2":{"name":"### atan2(y, x)","description":"\nMath.atan2() 返回从原点 (0,0) 到 (x,y) 点的线段与 x 轴正方向之间的平面角度 (弧度值)，也就是 Math.atan2(y,x)","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| y | number | 是 | - | - | 数值 |\n| x | number | 是 | - | - | 数值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"ceil":{"name":"### ceil(x)","description":"\nMath.ceil() 函数总是四舍五入并返回大于等于给定数字的最小整数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"cos":{"name":"### cos(x)","description":"\nMath.cos() 函数返回一个数值的余弦值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个以弧度为单位的数值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"exp":{"name":"### exp(x)","description":"\nMath.exp() 函数返回 e^x，x 表示参数，e 是欧拉常数（Euler's constant），自然对数的底数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"floor":{"name":"### floor(x)","description":"\nMath.floor() 函数总是返回小于等于一个给定数字的最大整数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"log":{"name":"### log(x)","description":"\nMath.log() 函数返回一个数的自然对数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"max":{"name":"### max(...values)","description":"\nMath.max() 函数返回作为输入参数的最大数字，如果没有参数，则返回 -Infinity","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| values | number[\\] | 是 | - | - | 0 个或多个数字，将在其中选择，并返回最大的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 给定数值中最大的数。如果任一参数不能转换为数值，则返回 NaN。如果没有提供参数，返回 -Infinity。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"min":{"name":"### min(...values)","description":"\nMath.min() 函数返回作为输入参数的数字中最小的一个，如果没有参数，则返回 Infinity。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| values | number[\\] | 是 | - | - | 0 个或多个数字，将在其中选择，并返回最小值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 给定数值中最小的数。如果任一参数不能转换为数值，则返回 NaN。如果没有提供参数，返回 Infinity。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"pow":{"name":"### pow(x, y)","description":"\nMath.pow() 函数返回基数（base）的指数（exponent）次幂，即 base^exponent。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 基数 |\n| y | number | 是 | - | - | 指数 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"random":{"name":"### random()","description":"\nMath.random() 函数返回一个浮点数，伪随机数在范围从0 到小于1，也就是说，从 0（包括 0）往上，但是不包括 1（排除 1），然后您可以缩放到所需的范围。实现将初始种子选择到随机数生成算法;它不能被用户选择或重置。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 一个浮点型伪随机数字，在0（包括 0）和1（不包括）之间。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"round":{"name":"### round(x)","description":"\nMath.round() 函数返回一个数字四舍五入后最接近的整数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 给定数字的值四舍五入到最接近的整数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"sin":{"name":"### sin(x)","description":"\nMath.sin() 函数返回一个数值的正弦值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值（以弧度为单位）。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"sqrt":{"name":"### sqrt(x)","description":"\nMath.sqrt() 函数返回一个数的平方根","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"tan":{"name":"### tan(x)","description":"\nMath.tan() 方法返回一个数值的正切值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值，表示一个角（单位：弧度）。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"clz32":{"name":"### clz32(x)","description":"\nMath.clz32() 函数返回一个数字在转换成 32 无符号整形数字的二进制形式后，开头的 0 的个数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"imul":{"name":"### imul(x, y)","description":"\n该函数将两个参数分别转换为 32 位整数，相乘后返回 32 位结果，类似 C 语言的 32 位整数相乘。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 被乘数。 |\n| y | number | 是 | - | - | 乘数。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | x |\n","itemType":"method"},"sign":{"name":"### sign(x)","description":"\nMath.sin() 函数返回一个数值的正弦值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值（以弧度为单位）。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"log10":{"name":"### log10(x)","description":"\nMath.log10() 函数返回一个数字以 10 为底的对数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 任意数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"log2":{"name":"### log2(x)","description":"\nMath.log2() 函数返回一个数字以 2 为底的对数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 任意数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"log1p":{"name":"### log1p(x)","description":"\nMath.log1p() 函数返回一个数字加 1 后的自然对数 (底为 E), 既log(x+1).","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 任意数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"expm1":{"name":"### expm1(x)","description":"\nMath.expm1() 函数返回 E^x - 1, 其中 x 是该函数的参数，E 是自然对数的底数 2.718281828459045。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 任意数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"cosh":{"name":"### cosh(x)","description":"\nMath.cosh() 函数返回数值的双曲余弦函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 数值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"sinh":{"name":"### sinh(x)","description":"\nMath.sinh() 函数返回一个数字 (单位为角度) 的双曲正弦值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 任意数字 (单位为度). | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"tanh":{"name":"### tanh(x)","description":"\nMath.tanh() 函数将会返回一个数的双曲正切函数值","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 待计算的数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"acosh":{"name":"### acosh(x)","description":"\nMath.acosh() 函数返回一个数的反双曲余弦值","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"asinh":{"name":"### asinh(x)","description":"\nMath.asinh() 返回一个数值的反双曲正弦值","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"atanh":{"name":"### atanh(x)","description":"\nMath.atanh() 函数返回一个数值反双曲正切值","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"hypot":{"name":"### hypot(...values)","description":"\nMath.hypot() 函数返回所有参数的平方和的平方根","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| values | number[\\] | 是 | - | - | 任意个数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | x |\n","itemType":"method"},"trunc":{"name":"### trunc(x)","description":"\nMath.trunc() 方法会将数字的小数部分去掉，只保留整数部分。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 任意数字 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"fround":{"name":"### fround(x)","description":"\nMath.fround() 可以将任意的数字转换为离它最近的单精度浮点数形式的数字。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个 Number。若参数为非数字类型，则会被转投成数字。无法转换时，设置成NaN。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | 3.9+ | x |\n","itemType":"method"},"cbrt":{"name":"### cbrt(x)","description":"\nMath.cbrt() 函数返回任意数字的立方根。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 任意数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | x |\n","itemType":"method"}},"Date":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Date)","toString":{"name":"### toString()","description":"\n返回一个字符串，以本地的时区表示该 Date 对象。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"toDateString":{"name":"### toDateString()","description":"\n以美式英语和人类易读的形式返回一个日期对象日期部分的字符串。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"toTimeString":{"name":"### toTimeString()","description":"\n以人类易读形式返回一个日期对象时间部分的字符串，该字符串以美式英语格式化。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"toLocaleString":{"name":"### toLocaleString()","description":"\n返回该日期对象的字符串，该字符串格式因不同语言而不同。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"toLocaleDateString":{"name":"### toLocaleDateString()","description":"\n返回指定日期对象日期部分的字符串，该字符串格式因不同语言而不同。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"toLocaleTimeString":{"name":"### toLocaleTimeString()","description":"\n返回该日期对象时间部分的字符串，该字符串格式因语言而异。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"valueOf":{"name":"### valueOf()","description":"\n返回从UTC时间1970年1月1日午夜开始以毫秒为单位存储的时间值。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getTime":{"name":"### getTime()","description":"\n返回从UTC时间1970年1月1日午夜开始以毫秒为单位存储的时间值。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"getFullYear":{"name":"### getFullYear()","description":"\n根据本地时间返回指定日期的年份。此方法替代 getYear() 。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 根据当地时间，返回一个对应于给定日期的年份数字。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"getUTCFullYear":{"name":"### getUTCFullYear()","description":"\n以世界时为标准，返回一个指定的日期对象的年份。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getMonth":{"name":"### getMonth()","description":"\n根据本地时间，返回一个指定的日期对象的月份，为基于 0 的值（0 表示一年中的第一月）。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 一个 0 到 11 的整数值：0 代表一月份，1 代表二月份，2 代表三月份，依次类推。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"getUTCMonth":{"name":"### getUTCMonth()","description":"\n以世界时为标准，返回一个指定的日期对象的月份，它是从 0 开始计数的（0 代表一年的第一个月）。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 11 的整数，分别对应以下月份：0 代表一月，1 代表二月，2 代表三月，依次类推。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getDate":{"name":"### getDate()","description":"\n根据本地时间，返回一个指定的日期对象为一个月中的哪一日（从 1--31）。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 1 到 31 的整数值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"getUTCDate":{"name":"### getUTCDate()","description":"\n以世界时为标准，返回一个指定的日期对象为一个月中的第几天","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 1 到 31 的整数值 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getDay":{"name":"### getDay()","description":"\n根据本地时间，返回一个具体日期中一周的第几天，0 表示星期天。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 根据本地时间，返回一个 0 到 6 之间的整数值，代表星期几：0 代表星期日，1 代表星期一，2 代表星期二，依次类推。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"getUTCDay":{"name":"### getUTCDay()","description":"\n以世界时为标准，返回一个指定的日期对象为一星期中的第几天，其中 0 代表星期天。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个对应一星期中第几天的整数：0 代表星期天，1 代表星期一，2 代表星期二，依次类推。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getHours":{"name":"### getHours()","description":"\n根据本地时间，返回一个指定的日期对象的小时。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 23 之间的整数值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"getUTCHours":{"name":"### getUTCHours()","description":"\n以世界时为标准，返回一个指定的日期对象的小时数。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 23 的整数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getMinutes":{"name":"### getMinutes()","description":"\n根据本地时间，返回一个指定的日期对象的分钟数。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 59 的整数值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"getUTCMinutes":{"name":"### getUTCMinutes()","description":"\n以世界时为标准，返回一个指定的日期对象的分钟数。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 59 的整数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getSeconds":{"name":"### getSeconds()","description":"\n根据本地时间，返回一个指定的日期对象的秒数。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 59 的整数值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"getUTCSeconds":{"name":"### getUTCSeconds()","description":"\n以世界时为标准，返回一个指定的日期对象的秒数。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 59 的整数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getUTCMilliseconds":{"name":"### getUTCMilliseconds()","description":"\n以世界时为标准，返回一个指定的日期对象的毫秒数。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 999 的整数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getTimezoneOffset":{"name":"### getTimezoneOffset()","description":"\n返回协调世界时（UTC）相对于当前时区的时间差值，单位为分钟。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 时区偏差（time-zone offset）表示协调世界时（UTC）与本地时区之间的差值，单位为分钟。需要注意的是如果本地时区后于协调世界时，则该差值为正值，如果先于协调世界时则为负值。例如你所在时区为 UTC+10（澳大利亚东部标准时间），将会返回 -600。对于同一个时区，夏令时（Daylight Saving Time）将会改变这个值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"setTime":{"name":"### setTime(time)","description":"\n以一个表示从 1970-1-1 00:00:00 UTC 计时的毫秒数为来为 Date 对象设置时间。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| time | number | 是 | - | - | 一个整数，表示从 1970-1-1 00:00:00 UTC 开始计时的毫秒数。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | UTC 1970 年 1 月 1 日 00:00:00 与更新日期之间的毫秒数（实际上是自变量的值）。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"setMilliseconds":{"name":"### setMilliseconds(ms)","description":"\n根据本地时间设置一个日期对象的豪秒数。如果指定的数字超出了合理范围，则日期对象的时间信息会被相应地更新。例如，如果指定了 1005，则秒数加 1，豪秒数为 5。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| ms | number | 是 | - | - | 一个 0 到 999 的数字，表示豪秒数。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回更新后的时间距 1970 年 1 月 1 日 00:00:00 的毫秒数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"setUTCMilliseconds":{"name":"### setUTCMilliseconds(ms)","description":"\n根据世界时来设置指定时间的毫秒数。如果传递的参数超出了指定的范围，setUTCMilliseconds() 方法会相应地尝试更新储存在 Date 的时间信息。例如，假设你传递参数的值是 1100，存储在 Date 的秒数会加 1，然后使用 100 来作为毫秒数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| ms | number | 是 | - | - | 0 - 999 之间的数值，代表毫秒数。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回更新后的时间距 1970 年 1 月 1 日 00:00:00 (UTC) 的毫秒数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"setSeconds":{"name":"### setSeconds(sec)","description":"\n根据本地时间设置一个日期对象的秒数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| sec | number | 是 | - | - | 一个 0 到 59 的整数。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"setUTCSeconds":{"name":"### setUTCSeconds(sec)","description":"\n为一个依据国际通用时间的特定日期设置秒数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| sec | number | 是 | - | - | 一个在 0 到 59 之间的整数，表示秒数。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"setMinutes":{"name":"### setMinutes(min)","description":"\n根据本地时间为一个日期对象设置分钟数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| min | number | 是 | - | - | 一个 0 到 59 的整数，表示分钟数。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"setUTCMinutes":{"name":"### setUTCMinutes(min)","description":"\n根据世界协调时（UTC）来设置指定日期的分钟数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| min | number | 是 | - | - | 必填，表示要设置的分钟数，是一个介于 0 和 59 之间的整数。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回从 UTC 时间 1970 年 1 月 1 日 0 时 0 分 0 秒至设置后的时间的毫秒数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"setHours":{"name":"### setHours(hours)","description":"\n根据本地时间为一个日期对象设置小时数，返回从 1970-01-01 00:00:00 UTC 到更新后的 日期 对象实例所表示时间的毫秒数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| hours | number | 是 | - | - | 必填，一个 0 到 23 的整数，表示小时。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"setUTCHours":{"name":"### setUTCHours(hours)","description":"\n根据世界协调时（UTC）为一个日期对象设置小时数，返回从 1970-01-01 00:00:00 UTC 到更新后的 日期 对象实例所表示时间的毫秒数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| hours | number | 是 | - | - | 必填，表示小时的整数，取值 0 到 23 之间。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回从 1970-01-01 00:00:00 UTC 到更新后的日期所表示时间的毫秒数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"setDate":{"name":"### setDate(date)","description":"\n根据本地时间来指定一个日期对象的天数。如果 dayValue 超出了月份的合理范围，setDate 将会相应地更新 Date 对象。例如，如果为 dayValue 指定 0，那么日期就会被设置为上个月的最后一天。如果 dayValue 被设置为负数，日期会设置为上个月最后一天往前数这个负数绝对值天数后的日期。-1 会设置为上月最后一天的前一天（译者注：例如当前为 4 月，如果 setDate(-2),则为 3 月 29 日）","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| date | number | 是 | - | - | 一个整数，表示该月的第几天。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"setUTCDate":{"name":"### setUTCDate(date)","description":"\n根据全球时间设置特定 date 对象的日期。如果你指定的参数超出了范围，setUTCDate() 会尝试更新对应的Date 中的日期信息。例如，如果你使用了 40 来作为参数，但是Date 中存储的月份为 6 月，那么日期将被改写为 10 且月份被增到 7 月。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| date | number | 是 | - | - | 一个 1-31 的整形数字，用来指定日期。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"setMonth":{"name":"### setMonth(month)","description":"\n根据本地时间为一个日期对象设置月份。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| month | number | 是 | - | - | 必填参数，介于 0 到 11 之间的整数（表示一月到十二月）。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 基于 1 January 1970 00:00:00 UTC 开始计算的毫秒数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"setUTCMonth":{"name":"### setUTCMonth(month)","description":"\n根据通用的时间（ UTC ）来设置一个准确的月份。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| month | number | 是 | - | - | 必填参数，一个 0-11 的整数，代表 1 月到 12 月。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 这个数值是从 1970 年 1 月 1 号 00:00:00 到当前时间的毫秒数（国际通用时间） | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"setFullYear":{"name":"### setFullYear(year)","description":"\n根据本地时间为一个日期对象设置年份。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| year | number | 是 | - | - | 指定年份的整数值，例如 1995。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"setUTCFullYear":{"name":"### setUTCFullYear(year)","description":"\n根据世界标准时间 (UTC) 为一个具体日期设置年份。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| year | number | 是 | - | - | 指定年份整数值，例如，1995 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"toUTCString":{"name":"### toUTCString()","description":"把一个日期转换为一个字符串，使用 UTC 时区。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"toISOString":{"name":"### toISOString()","description":"一个 ISO（ISO 8601 Extended Format）格式的字符串： YYYY-MM-DDTHH:mm:ss.sssZ。时区总是 UTC（协调世界时），加一个后缀“Z”标识。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| √ | x | 4.0 | 4.11 | x | √ |\n","itemType":"method"},"toJSON":{"name":"### toJSON(key?)","description":"返回 Date 对象的字符串形式。调用 toJSON() 返回一个 JSON 格式字符串 (使用 toISOString())，表示该日期对象的值。默认情况下，这个方法常用于 JSON序列化Date对象。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | any | 否 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| √ | x | 4.0 | 4.11 | x | √ |\n","itemType":"method"},"parse":{"name":"### parse(s)","description":"\n解析一个表示某个日期的字符串，并返回从 1970-1-1 00:00:00 UTC 到该日期对象（该日期对象的 UTC 时间）的毫秒数，如果该字符串无法识别，或者一些情况下，包含了不合法的日期数值（如：2015-02-31），则返回值为 NaN。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| s | string | 是 | - | - | 一个符合 RFC2822 或 ISO 8601 日期格式的字符串（其他格式也许也支持，但结果可能与预期不符）。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 一个表示从 1970-1-1 00:00:00 UTC 到给定日期字符串所表示时间的毫秒数的数值。如果参数不能解析为一个有效的日期，则返回NaN。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"UTC":{"name":"### UTC(year, monthIndex, date?, hours?, minutes?, seconds?, ms?)","description":"\n接受的参数同 Date 构造函数接受最多参数时一样，但该前者会视它们为 UTC 时间，其返回从 1970 年 1 月 1 日 00:00:00 UTC 到指定时间的毫秒数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| year | number | 是 | - | - | 一个表示年份的整数值。从 0 到 99 的值会被映射到 1900 至 1999 年。其他的值则代表实际的年份。 |\n| monthIndex | number | 是 | - | - | 0（一月）到 11（十二月）之间的一个整数，表示月份。从 ECMAScript 2017 开始，如果忽略该值，则默认为 0。（直到 ECMAScript 2016，month 都是必须的参数。而从 ES2017 开始，它不再是必须的。） |\n| date | number | 是 | - | - | 1 到 31 之间的一个整数，表示某月当中的第几天。如果忽略该值，则默认为 1。 |\n| hours | number | 是 | - | - | 0 到 23 之间的一个整数，表示小时。如果忽略该值，则默认为 0。 |\n| minutes | number | 是 | - | - | 0 到 59 之间的一个整数，表示分钟。如果忽略该值，则默认为 0。 |\n| seconds | number | 是 | - | - | 0 到 59 之间的一个整数，表示秒。如果忽略该值，则默认为 0。 |\n| ms | number | 是 | - | - | 0 到 999 之间的一个整数，表示毫秒。如果忽略该值，则默认为 0。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 一个数字，表示从 1970 年 1 月 1 日 00:00:00 UTC 到给定时间的毫秒数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"now":{"name":"### now()","description":"\n返回自 1970 年 1 月 1 日 00:00:00 (UTC) 到当前时间的毫秒数。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"}},"RegExp":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.RegExp)","flags":{"name":"### flags","description":"\n返回一个字符串，由当前正则表达式对象的标志组成。此属性是一个只读属性\n此字符串中的字符按以下顺序排序和连接:\n\n - \"g\" for global\n - \"i\" for ignoreCase\n - \"m\" for multiline\n - \"u\" for unicode\n - \"y\" for sticky\n\n如果没有设置标志，则该值为空字符串。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"dotAll":{"name":"### dotAll","description":"\n表明是否在正则表达式中一起使用\"s\"修饰符（引入/s 修饰符，使得。可以匹配任意单个字符）。dotAll 是一个只读的属性，属于单个正则表达式实例。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"hasIndices":{"name":"### hasIndices","description":"\n指示 d 标志是否与正则表达式一起使用。只读的。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"sticky":{"name":"### sticky","description":"\n搜索是否具有粘性（仅从正则表达式的 lastIndex 属性表示的索引处搜索）。sticky 是正则表达式对象的只读属性。默认为false。只读的。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"unicode":{"name":"### unicode","description":"\n表明正则表达式带有\"u\" 标志。 unicode 是正则表达式独立实例的只读属性。unicode 的值是 Boolean，并且如果使用了 \"u\" 标志则为 true；否则为 false。\"u\" 标志开启了多种 Unicode 相关的特性。使用 \"u\" 标志，任何 Unicode 代码点的转义都会被解释。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"source":{"name":"### source","description":"\n返回一个值为当前正则表达式对象的模式文本的字符串，该字符串不会包含正则字面量两边的斜杠以及任何的标志字符。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"global":{"name":"### global","description":"\n表明正则表达式是否使用了 \"g\" 标志。global 是一个正则表达式实例的只读属性。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"ignoreCase":{"name":"### ignoreCase","description":"\n表明正则表达式是否使用了 \"i\" 标志。ignoreCase 是正则表达式实例的只读属性。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"multiline":{"name":"### multiline","description":"\n表明正则表达式是否使用了 \"m\" 标志。multiline 是正则表达式实例的一个只读属性。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"lastIndex":{"name":"### lastIndex","description":"\n正则表达式的一个可读可写的整型属性，用来指定下一次匹配的起始索引。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"exec":{"name":"### exec(string)","description":"\n在一个指定字符串中执行一个搜索匹配。返回一个结果数组或 null。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| string | string | 是 | - | - | 要匹配正则表达式的字符串。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| RegExpExecArray \\| null | 如果匹配失败，exec() 方法返回 null，并将正则表达式的 lastIndex 重置为 0。如果匹配成功，exec() 方法返回一个数组，并更新正则表达式对象的 lastIndex 属性。完全匹配成功的文本将作为返回数组的第一项，从第二项起，后续每项都对应一个匹配的捕获组。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"test":{"name":"### test(string)","description":"\n执行一个检索，用来查看正则表达式与指定的字符串是否匹配。返回 true 或 false。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| string | string | 是 | - | - | 用来与正则表达式匹配的字符串。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果正则表达式与指定的字符串匹配，返回true；否则false。如果正则表达式设置了全局标志，test() 的执行会改变正则表达式 lastIndex属性。连续的执行test()方法，后续的执行将会从 lastIndex 处开始匹配字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"}},"JSON":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.JSON)","parse":{"name":"### parse(text, reviver?)","description":"\nJSON.parse() 方法用来解析 JSON 字符串，构造由字符串描述的 JavaScript 值或对象。提供可选的 reviver 函数用以在返回之前对所得到的对象执行变换 (操作)。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| text | string | 是 | - | - | 要被解析成 JavaScript 值的字符串 |\n| reviver | (this: any, key: string, value: any) => any | 是 | - | - | \\[可选]转换器，如果传入该参数 (函数)，可以用来修改解析生成的原始值，调用时机在 parse 函数返回之前。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| any \\| null | 返回一个any 或者 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"parse_1":{"name":"### parse(text)","description":"\nJSON.parse() 方法用来解析 JSON 字符串，构造由字符串描述的值或者对象，其类型由泛型参数T决定\n如果输入的是一个合法的json值或者对象，返回一个对应的T值或者对象，如果json描述的值或对象和 T 指定的类型不符，将返回null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| text | string | 是 | - | - | 要被解析成 JavaScript 值的字符串 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T \\| null | 返回一个T类型的值或者对象 或者 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | x |\n","itemType":"method"},"parseObject":{"name":"### parseObject(text)","description":"\nJSON.parseObject() 方法用来解析 JSON 字符串，构造由字符串描述的对象。\n如果输入的是一个合法的json对象，返回一个对应的UTSJSONObject，如果是json array 或者其他格式的字符串返回null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| text | string | 是 | - | - | 要被解析成 JavaScript 值的字符串 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UTSJSONObject \\| null | 返回一个UTSJSONObjet 或者 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | x |\n","itemType":"method"},"parseObject_1":{"name":"### parseObject(text)","description":"\nJSON.parseObject() 方法用来解析 JSON 字符串，构造由字符串描述的对象，该对象的类型由泛型参数T决定\n如果输入的是一个合法的json对象，返回一个对应的T对象，如果是json array 或者其他格式的字符串返回null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| text | string | 是 | - | - | 要被解析成 JavaScript 值的字符串 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T \\| null | 返回一个T类型对象 或者 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | x |\n","itemType":"method"},"parseArray":{"name":"### parseArray(text)","description":"\nJSON.parseArray() 方法用来解析 JSON 字符串，构造由字符串描述的数组。数组元素类型为any\n如果输入的是一个合法的json数组，返回一个对应的Array，如果是json object 或者其他格式的字符串返回null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| text | string | 是 | - | - | 要被解析成 JavaScript 值的字符串 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Array\\ \\| null | 返回一个Array 或者 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | x |\n","itemType":"method"},"parseArray_1":{"name":"### parseArray(text)","description":"\nJSON.parseArray() 方法用来解析 JSON 字符串，构造由字符串描述的数组。数组元素类型由泛型T决定\n如果输入的是一个合法的json数组，返回一个对应的Array，如果是json object 或者其他格式的字符串返回null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| text | string | 是 | - | - | 要被解析成 JavaScript 值的字符串 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Array\\ \\| null | 返回一个Array 或者 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | x |\n","itemType":"method"},"stringify":{"name":"### stringify(value)","description":"\nJSON.stringify() 方法将一个 JavaScript 对象或值转换为 JSON 字符串，如果指定了一个 replacer 函数，则可以选择性地替换值，或者指定的 replacer 是数组，则可选择性地仅包含数组指定的属性","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | any \\| null | 否 | - | - | 将要序列化成 一个 JSON 字符串的值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"}},"Array":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Array)","length":{"name":"### length","description":"\nlength 是 Array 的实例属性，表示该数组中元素的个数。该值是一个无符号 32 位整数，并且其数值总是大于数组最大索引。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"toString":{"name":"### toString()","description":"\ntoString() 方法返回一个字符串，表示指定的数组及其元素。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"toKotlinList":{"name":"### toKotlinList()","description":"\ntoKotlinList() 将当前的Array对象转换为 kotlin 中对应的List对象","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| kotlin.collections.List\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"add":{"name":"### add(item)","description":"\n将指定的元素追加到此列表的末尾","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| item | T | 是 | - | - | 添加到数组的元素。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 是否成功添加 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"toLocaleString":{"name":"### toLocaleString()","description":"\ntoLocaleString() 方法返回一个字符串，表示数组中的所有元素。每个元素通过调用它们自己的 toLocaleString 方法转换为字符串，并且使用特定于语言环境的字符串（例如逗号“,”）分隔开。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"joinToString":{"name":"### joinToString(separator)","description":"\n从所有元素中使用\\[separator]建字符串","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| separator | string | 是 | - | - | 分隔符 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 拼接完成的字符串 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"pop":{"name":"### pop()","description":"\npop() 方法从数组中删除最后一个元素，并返回该元素的值。此方法会更改数组的长度。\n","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T \\| null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"push":{"name":"### push(...items)","description":"\npush() 方法将指定的元素添加到数组的末尾，并返回新的数组长度。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| items | T[\\] | 是 | - | - | 添加到数组末尾的元素。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 调用方法的对象的新 length 属性。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"concat":{"name":"### concat(...items)","description":"\nconcat() 方法用于合并两个或多个数组。此方法不会更改现有数组，而是返回一个新数组。\n","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| items | ConcatArray\\[\\] | 是 | - | - | 数组和/或值，将被合并到一个新的数组中。如果省略了所有 valueN 参数，则 concat 会返回调用此方法的现存数组的一个浅拷贝。详情请参阅下文描述。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T[\\] | 新的 Array 实例。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"concat_1":{"name":"### concat(...items)","description":"\nconcat() 方法用于合并两个或多个数组。此方法不会更改现有数组，而是返回一个新数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| items | (T \\| ConcatArray\\)[\\] | 是 | - | - | 数组和/或值，将被合并到一个新的数组中。如果省略了所有 valueN 参数，则 concat 会返回调用此方法的现存数组的一个浅拷贝。详情请参阅下文描述。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T[\\] | 新的 Array 实例。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"join":{"name":"### join(separator?)","description":"\njoin() 方法将一个数组（或一个类数组对象）的所有元素连接成一个字符串并返回这个字符串，用逗号或指定的分隔符字符串分隔。如果数组只有一个元素，那么将返回该元素而不使用分隔符。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| separator | string | 是 | - | - | 指定一个字符串来分隔数组的每个元素。如果需要，将分隔符转换为字符串。如果省略，数组元素用逗号（,）分隔。如果 separator 是空字符串（\"\"），则所有元素之间都没有任何字符。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个所有数组元素连接的字符串。如果 arr.length 为 0，则返回空字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | - | √ | √ | - |\n","itemType":"method"},"reverse":{"name":"### reverse()","description":"\nreverse() 方法就地反转数组中的元素，并返回同一数组的引用。数组的第一个元素会变成最后一个，数组的最后一个元素变成第一个。换句话说，数组中的元素顺序将被翻转，变为与之前相反的方向。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T[\\] | 原始数组反转后的引用。注意，数组是就地反转的，并且没有复制。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"shift":{"name":"### shift()","description":"\nshift() 方法从数组中删除第一个元素，并返回该元素的值。此方法更改数组的长度。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T \\| null | 从数组中删除的元素；如果数组为空则返回 null。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"slice":{"name":"### slice(start?, end?)","description":"\nslice() 方法返回一个新的数组对象，这一对象是一个由 start 和 end 决定的原数组的浅拷贝（包括 start，不包括 end），其中 start 和 end 代表了数组元素的索引。原始数组不会被改变。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| start | number | 是 | - | - | 提取起始处的索引（从 0 开始），会转换为整数。 |\n| end | number | 是 | - | - | 提取终止处的索引（从 0 开始），会转换为整数。slice() 会提取到但不包括 end 的位置。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"sort":{"name":"### sort(compareFn?)","description":"\nsort() 方法就地对数组的元素进行排序，并返回对相同数组的引用。默认排序是将元素转换为字符串，然后按照它们的 UTF-16 码元值升序排序。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| compareFn | (a: T, b: T) => number | 是 | - | - | 定义排序顺序的函数。返回值应该是一个数字，其正负性表示两个元素的相对顺序。该函数使用以下参数调用： a:第一个用于比较的元素。不会是 null。 b:第二个用于比较的元素。不会是 null。 如果省略该函数，数组元素会被转换为字符串，然后根据每个字符的 Unicode 码位值进行排序。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| this | 经过排序的原始数组的引用。注意数组是就地排序的，不会进行复制。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"splice":{"name":"### splice(start, deleteCount?)","description":"\nsplice() 方法通过移除或者替换已存在的元素和/或添加新元素就地改变一个数组的内容。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| start | number | 是 | - | - | 从 0 开始计算的索引，表示要开始改变数组的位置，它会被转换成整数。 |\n| deleteCount | number | 是 | - | - | 一个整数，表示数组中要从 start 开始删除的元素数量。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T[\\] | 一个包含了删除的元素的数组。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"splice_1":{"name":"### splice(start, deleteCount, ...items)","description":"\nsplice() 方法通过移除或者替换已存在的元素和/或添加新元素就地改变一个数组的内容。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| start | number | 是 | - | - | 从 0 开始计算的索引，表示要开始改变数组的位置，它会被转换成整数。 |\n| deleteCount | number | 是 | - | - | 一个整数，表示数组中要从 start 开始删除的元素数量。 |\n| items | T[\\] | 是 | - | - | 添加到 arr 开头的元素。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T[\\] | 一个包含了删除的元素的数组。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"unshift":{"name":"### unshift(...items)","description":"\nunshift() 方法将指定元素添加到数组的开头，并返回数组的新长度。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| items | T[\\] | 是 | - | - | 添加到 arr 开头的元素。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"indexOf":{"name":"### indexOf(searchElement, fromIndex?)","description":"\nindexOf() 方法返回数组中第一次出现给定元素的下标，如果不存在则返回 -1。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchElement | T | 是 | - | - | 数组中要查找的元素。 |\n| fromIndex | number | 是 | - | - | 开始搜索的索引（从零开始），会转换为整数。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"lastIndexOf":{"name":"### lastIndexOf(searchElement, fromIndex?)","description":"\nlastIndexOf() 方法返回数组中给定元素最后一次出现的索引，如果不存在则返回 -1。该方法从 fromIndex 开始向前搜索数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchElement | T | 是 | - | - | 被查找的元素。 |\n| fromIndex | number | 是 | - | - | 以 0 起始的索引，表明反向搜索的起始位置，会被转换为整数。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"every":{"name":"### every(predicate, thisArg?)","description":"\nevery() 方法测试一个数组内的所有元素是否都能通过指定函数的测试。它返回一个布尔值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index?: number, array?: Array\\) => boolean | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试，否则返回一个假值。该函数被调用时将传入以下参数： value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 array:调用了 every() 的数组本身。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| this is S[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"every_1":{"name":"### every(predicate, thisArg?)","description":"\nevery() 方法测试一个数组内的所有元素是否都能通过指定函数的测试。它返回一个布尔值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number, array: Array\\) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试，否则返回一个假值。该函数被调用时将传入以下参数： value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 array:调用了 every() 的数组本身。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| boolean | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"every_2":{"name":"### every(predicate, thisArg?)","description":"\nevery() 方法测试一个数组内的所有元素是否都能通过指定函数的测试。它返回一个布尔值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试，否则返回一个假值。该函数被调用时将传入以下参数： value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| boolean | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"every_3":{"name":"### every(predicate, thisArg?)","description":"\nevery() 方法测试一个数组内的所有元素是否都能通过指定函数的测试。它返回一个布尔值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试，否则返回一个假值。该函数被调用时将传入以下参数： value:数组中当前正在处理的元素。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| boolean | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"some":{"name":"### some(predicate, thisArg?)","description":"\nsome() 方法测试数组中是否至少有一个元素通过了由提供的函数实现的测试。如果在数组中找到一个元素使得提供的函数返回 true，则返回 true；否则返回 false。它不会修改数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number, array: Array\\) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试，否则返回一个假值。该函数被调用时将传入以下参数： value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 array:调用了 some() 的数组本身。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果回调函数对数组中至少一个元素返回一个真值，则返回 true。否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"some_1":{"name":"### some(predicate, thisArg?)","description":"\nsome() 方法测试数组中是否至少有一个元素通过了由提供的函数实现的测试。如果在数组中找到一个元素使得提供的函数返回 true，则返回 true；否则返回 false。它不会修改数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试，否则返回一个假值。该函数被调用时将传入以下参数： value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果回调函数对数组中至少一个元素返回一个真值，则返回 true。否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"some_2":{"name":"### some(predicate, thisArg?)","description":"\nsome() 方法测试数组中是否至少有一个元素通过了由提供的函数实现的测试。如果在数组中找到一个元素使得提供的函数返回 true，则返回 true；否则返回 false。它不会修改数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试，否则返回一个假值。该函数被调用时将传入以下参数： value:数组中当前正在处理的元素。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果回调函数对数组中至少一个元素返回一个真值，则返回 true。否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach":{"name":"### forEach(callbackfn, thisArg?)","description":"\nforEach() 方法对数组的每个元素执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T, index: number, array: Array\\) => void | 是 | - | - | 为数组中每个元素执行的函数。并会丢弃它的返回值。该函数被调用时将传入以下参数： value:数组中正在处理的当前元素。 index:数组中正在处理的当前元素的索引。 array:调用了 forEach() 的数组本身。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach_1":{"name":"### forEach(callbackfn, thisArg?)","description":"\nforEach() 方法对数组的每个元素执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T, index: number) => void | 是 | - | - | 为数组中每个元素执行的函数。并会丢弃它的返回值。该函数被调用时将传入以下参数： value:数组中正在处理的当前元素。 index:数组中正在处理的当前元素的索引。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach_2":{"name":"### forEach(callbackfn, thisArg?)","description":"\nforEach() 方法对数组的每个元素执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T) => void | 是 | - | - | 为数组中每个元素执行的函数。并会丢弃它的返回值。该函数被调用时将传入以下参数： value:数组中正在处理的当前元素。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"map":{"name":"### map(callbackfn, thisArg?)","description":"\nmap() 方法创建一个新数组，这个新数组由原数组中的每个元素都调用一次提供的函数后的返回值组成。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T, index: number, array: Array\\) => any | 是 | - | - | 为数组中的每个元素执行的函数。它的返回值作为一个元素被添加为新数组中。该函数被调用时将传入以下参数： value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 array:调用了 map() 的数组本身。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| U[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"map_1":{"name":"### map(callbackfn, thisArg?)","description":"\nmap() 方法创建一个新数组，这个新数组由原数组中的每个元素都调用一次提供的函数后的返回值组成。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T, index: number) => any | 是 | - | - | 为数组中的每个元素执行的函数。它的返回值作为一个元素被添加为新数组中。该函数被调用时将传入以下参数： value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| U[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"map_2":{"name":"### map(callbackfn, thisArg?)","description":"\nmap() 方法创建一个新数组，这个新数组由原数组中的每个元素都调用一次提供的函数后的返回值组成。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T) => any | 是 | - | - | 为数组中的每个元素执行的函数。它的返回值作为一个元素被添加为新数组中。该函数被调用时将传入以下参数： value:数组中当前正在处理的元素。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| U[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"filter":{"name":"### filter(predicate, thisArg?)","description":"\nfilter() 方法创建给定数组一部分的浅拷贝，其包含通过所提供函数实现的测试的所有元素。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index?: number, array?: Array\\) => boolean | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以将元素保留在结果数组中，否则返回一个假值。该函数被调用时将传入以下参数： value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 array:调用了 filter() 的数组本身。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| S[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"filter_1":{"name":"### filter(predicate, thisArg?)","description":"\nfilter() 方法创建给定数组一部分的浅拷贝，其包含通过所提供函数实现的测试的所有元素。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number, array: Array\\) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以将元素保留在结果数组中，否则返回一个假值。该函数被调用时将传入以下参数： value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 array:调用了 filter() 的数组本身。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"filter_2":{"name":"### filter(predicate, thisArg?)","description":"\nfilter() 方法创建给定数组一部分的浅拷贝，其包含通过所提供函数实现的测试的所有元素。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以将元素保留在结果数组中，否则返回一个假值。该函数被调用时将传入以下参数： value:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"filter_3":{"name":"### filter(predicate, thisArg?)","description":"\nfilter() 方法创建给定数组一部分的浅拷贝，其包含通过所提供函数实现的测试的所有元素。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以将元素保留在结果数组中，否则返回一个假值。该函数被调用时将传入以下参数： value:数组中当前正在处理的元素。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduce":{"name":"### reduce(callbackfn)","description":"\nreduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数，每一次运行 reducer 会将先前元素的计算结果作为参数传入，最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T, currentIndex: number, array: Array\\) => T | 是 | - | - | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数： previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为 array\\[0] 的值。 currentValue:当前元素的值。在第一次调用时，如果指定了 initialValue，则为 array[0] 的值，否则为 array[1] currentIndex:currentValue 在数组中的索引位置。在第一次调用时，如果指定了 initialValue 则为 0，否则为 1 array:调用了 reduce() 的数组本身。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduce_1":{"name":"### reduce(callbackfn)","description":"\nreduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数，每一次运行 reducer 会将先前元素的计算结果作为参数传入，最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T, currentIndex: number) => T | 是 | - | - | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数： previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为 array\\[0] 的值。 currentValue:当前元素的值。在第一次调用时，如果指定了 initialValue，则为 array[0] 的值，否则为 array[1] currentIndex:currentValue 在数组中的索引位置。在第一次调用时，如果指定了 initialValue 则为 0，否则为 1 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduce_2":{"name":"### reduce(callbackfn, initialValue)","description":"\nreduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数，每一次运行 reducer 会将先前元素的计算结果作为参数传入，最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T, currentIndex: number, array: Array\\) => T | 是 | - | - | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数： previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为 array\\[0] 的值。 currentValue:当前元素的值。在第一次调用时，如果指定了 initialValue，则为 array[0] 的值，否则为 array[1] currentIndex:currentValue 在数组中的索引位置。在第一次调用时，如果指定了 initialValue 则为 0，否则为 1 array:调用了 reduce() 的数组本身。 |\n| initialValue | T | 是 | - | - | 第一次调用回调时初始化 accumulator 的值。如果指定了 initialValue，则 callbackFn 从数组中的第一个值作为 currentValue 开始执行。如果没有指定 initialValue，则 accumulator 初始化为数组中的第一个值，并且 callbackFn 从数组中的第二个值作为 currentValue 开始执行。在这种情况下，如果数组为空（没有第一个值可以作为 accumulator 返回），则会抛出错误。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduce_3":{"name":"### reduce(callbackfn, initialValue)","description":"\nreduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数，每一次运行 reducer 会将先前元素的计算结果作为参数传入，最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T, currentIndex: number) => T | 是 | - | - | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数： previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为 array\\[0] 的值。 currentValue:当前元素的值。在第一次调用时，如果指定了 initialValue，则为 array[0] 的值，否则为 array[1] currentIndex:currentValue 在数组中的索引位置。在第一次调用时，如果指定了 initialValue 则为 0，否则为 1 |\n| initialValue | T | 是 | - | - | 第一次调用回调时初始化 accumulator 的值。如果指定了 initialValue，则 callbackFn 从数组中的第一个值作为 currentValue 开始执行。如果没有指定 initialValue，则 accumulator 初始化为数组中的第一个值，并且 callbackFn 从数组中的第二个值作为 currentValue 开始执行。在这种情况下，如果数组为空（没有第一个值可以作为 accumulator 返回），则会抛出错误。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduce_4":{"name":"### reduce(callbackfn, initialValue)","description":"\nreduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数，每一次运行 reducer 会将先前元素的计算结果作为参数传入，最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T) => T | 是 | - | - | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数： previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为 array\\[0] 的值。 currentValue:当前元素的值。在第一次调用时，如果指定了 initialValue，则为 array[0] 的值，否则为 array[1] |\n| initialValue | T | 是 | - | - | 第一次调用回调时初始化 accumulator 的值。如果指定了 initialValue，则 callbackFn 从数组中的第一个值作为 currentValue 开始执行。如果没有指定 initialValue，则 accumulator 初始化为数组中的第一个值，并且 callbackFn 从数组中的第二个值作为 currentValue 开始执行。在这种情况下，如果数组为空（没有第一个值可以作为 accumulator 返回），则会抛出错误。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduce_5":{"name":"### reduce(callbackfn, initialValue)","description":"\nreduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数，每一次运行 reducer 会将先前元素的计算结果作为参数传入，最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: any, currentValue: T, currentIndex?: number, array?: Array\\) => any | 是 | - | - | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数： previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为 array\\[0] 的值。 currentValue:当前元素的值。在第一次调用时，如果指定了 initialValue，则为 array[0] 的值，否则为 array[1] currentIndex:currentValue 在数组中的索引位置。在第一次调用时，如果指定了 initialValue 则为 0，否则为 1 array:调用了 reduce() 的数组本身。 |\n| initialValue | U | 是 | - | - | 第一次调用回调时初始化 accumulator 的值。如果指定了 initialValue，则 callbackFn 从数组中的第一个值作为 currentValue 开始执行。如果没有指定 initialValue，则 accumulator 初始化为数组中的第一个值，并且 callbackFn 从数组中的第二个值作为 currentValue 开始执行。在这种情况下，如果数组为空（没有第一个值可以作为 accumulator 返回），则会抛出错误。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| U | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"reduceRight":{"name":"### reduceRight(callbackfn)","description":"\nreduceRight() 方法对累加器（accumulator）和数组的每个值（按从右到左的顺序）应用一个函数，并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T, currentIndex: number, array: Array\\) => T | 是 | - | - | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数： previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为数组最后一个元素的值。 currentValue:数组中当前正在处理的元素。 currentIndex:正在处理的元素在数组中的索引。 array:调用了 reduceRight() 的数组本身。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduceRight_1":{"name":"### reduceRight(callbackfn)","description":"\nreduceRight() 方法对累加器（accumulator）和数组的每个值（按从右到左的顺序）应用一个函数，并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T, currentIndex: number) => T | 是 | - | - | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数： previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为数组最后一个元素的值。 currentValue:数组中当前正在处理的元素。 currentIndex:正在处理的元素在数组中的索引。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduceRight_2":{"name":"### reduceRight(callbackfn)","description":"\nreduceRight() 方法对累加器（accumulator）和数组的每个值（按从右到左的顺序）应用一个函数，并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T) => T | 是 | - | - | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数： previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为数组最后一个元素的值。 currentValue:数组中当前正在处理的元素。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduceRight_3":{"name":"### reduceRight(callbackfn, initialValue)","description":"\nreduceRight() 方法对累加器（accumulator）和数组的每个值（按从右到左的顺序）应用一个函数，并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T, currentIndex: number, array: Array\\) => T | 是 | - | - | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数： previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为数组最后一个元素的值。 currentValue:数组中当前正在处理的元素。 currentIndex:正在处理的元素在数组中的索引。 array:调用了 reduceRight() 的数组本身。 |\n| initialValue | T | 是 | - | - | 首次调用 callbackFn 时累加器的值。如果不提供初始值，则将使用数组中的最后一个元素，并在迭代时跳过它。没有初始值的情况下，在空数组上调用 reduceRight() 会产生 TypeError。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduceRight_4":{"name":"### reduceRight(callbackfn, initialValue)","description":"\nreduceRight() 方法对累加器（accumulator）和数组的每个值（按从右到左的顺序）应用一个函数，并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T, currentIndex: number) => T | 是 | - | - | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数： previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为数组最后一个元素的值。 currentValue:数组中当前正在处理的元素。 currentIndex:正在处理的元素在数组中的索引。 |\n| initialValue | T | 是 | - | - | 首次调用 callbackFn 时累加器的值。如果不提供初始值，则将使用数组中的最后一个元素，并在迭代时跳过它。没有初始值的情况下，在空数组上调用 reduceRight() 会产生 TypeError。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduceRight_5":{"name":"### reduceRight(callbackfn, initialValue)","description":"\nreduceRight() 方法对累加器（accumulator）和数组的每个值（按从右到左的顺序）应用一个函数，并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T) => T | 是 | - | - | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数： previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为数组最后一个元素的值。 currentValue:数组中当前正在处理的元素。 |\n| initialValue | T | 是 | - | - | 首次调用 callbackFn 时累加器的值。如果不提供初始值，则将使用数组中的最后一个元素，并在迭代时跳过它。没有初始值的情况下，在空数组上调用 reduceRight() 会产生 TypeError。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduceRight_6":{"name":"### reduceRight(callbackfn, initialValue)","description":"\nreduceRight() 方法对累加器（accumulator）和数组的每个值（按从右到左的顺序）应用一个函数，并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: any, currentValue: T, currentIndex?: number, array?: Array\\) => any | 是 | - | - | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数： previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为数组最后一个元素的值。 currentValue:数组中当前正在处理的元素。 index:正在处理的元素在数组中的索引。 array:调用了 reduceRight() 的数组本身。 |\n| initialValue | U | 是 | - | - | 首次调用 callbackFn 时累加器的值。如果不提供初始值，则将使用数组中的最后一个元素，并在迭代时跳过它。没有初始值的情况下，在空数组上调用 reduceRight() 会产生 TypeError。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| U | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"find":{"name":"### find(predicate, thisArg?)","description":"\nfind() 方法返回数组中满足提供的测试函数的第一个元素的值。否则返回 null。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number, obj: Array\\) => boolean | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值来表示已经找到了匹配的元素。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| S \\| null | 数组中第一个满足所提供测试函数的元素的值，否则返回 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"find_1":{"name":"### find(predicate, thisArg?)","description":"\nfind() 方法返回数组中满足提供的测试函数的第一个元素的值。否则返回 null。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number) => boolean | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值来表示已经找到了匹配的元素。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| S \\| null | 数组中第一个满足所提供测试函数的元素的值，否则返回 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"find_2":{"name":"### find(predicate, thisArg?)","description":"\nfind() 方法返回数组中满足提供的测试函数的第一个元素的值。否则返回 null。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T) => boolean | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值来表示已经找到了匹配的元素。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| S \\| null | 数组中第一个满足所提供测试函数的元素的值，否则返回 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"findIndex":{"name":"### findIndex(predicate, thisArg?)","description":"\nfindIndex() 方法返回数组中满足提供的测试函数的第一个元素的索引。若没有找到对应元素则返回 -1。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number, obj: Array\\) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示已找到匹配元素，否则返回一个假值。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 数组中第一个满足测试条件的元素的索引。否则返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"findIndex_1":{"name":"### findIndex(predicate, thisArg?)","description":"\nfindIndex() 方法返回数组中满足提供的测试函数的第一个元素的索引。若没有找到对应元素则返回 -1。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示已找到匹配元素，否则返回一个假值。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 数组中第一个满足测试条件的元素的索引。否则返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"findIndex_2":{"name":"### findIndex(predicate, thisArg?)","description":"\nfindIndex() 方法返回数组中满足提供的测试函数的第一个元素的索引。若没有找到对应元素则返回 -1。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示已找到匹配元素，否则返回一个假值。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 数组中第一个满足测试条件的元素的索引。否则返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"fill":{"name":"### fill(value, start?, end?)","description":"\nfill() 方法用一个固定值填充一个数组中从起始索引（默认为 0）到终止索引（默认为 array.length）内的全部元素。它返回修改后的数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | T | 是 | - | - | 用来填充数组元素的值。注意所有数组中的元素都将是这个确定的值：如果 value 是个对象，那么数组的每一项都会引用这个元素。 |\n| start | number | 是 | - | - | 基于零的索引，从此开始填充，转换为整数。 |\n| end | number | 是 | - | - | 基于零的索引，在此结束填充，转换为整数。fill() 填充到但不包含 end 索引。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| this | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"copyWithin":{"name":"### copyWithin(target, start?, end?)","description":"\ncopyWithin() 方法浅复制数组的一部分到同一数组中的另一个位置，并返回它，不会改变原数组的长度。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| target | number | 是 | - | - | 序列开始替换的目标位置，以 0 为起始的下标表示，且将被转换为整数 |\n| start | number | 是 | - | - | 要复制的元素序列的起始位置，以 0 为起始的下标表示，且将被转换为整数 |\n| end | number | 是 | - | - | 要复制的元素序列的结束位置，以 0 为起始的下标表示，且将被转换为整数。copyWithin 将会拷贝到该位置，但不包括 end 这个位置的元素。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| this | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"includes":{"name":"### includes(searchElement, fromIndex?)","description":"\nincludes() 方法用来判断一个数组是否包含一个指定的值，根据情况，如果包含则返回 true，否则返回 false。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchElement | any | 是 | - | - | 需要查找的值。 |\n| fromIndex | number | 是 | - | - | 可选。开始搜索的索引（从零开始），会转换为整数。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 一个布尔值，如果在数组中（或者在 fromIndex 所指示的数组部分中，如果指定 fromIndex 的话）找到 searchElement 值，则该值为 true。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"isArray":{"name":"### isArray(arg)","description":"\nArray.isArray() 静态方法用于确定传递的值是否是一个 Array。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | any | 是 | - | - | 需要检测的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| arg is any[\\] | 如果 value 是 Array，则为 true；否则为 false。如果 value 是 TypedArray 实例，则总是返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"}},"Map":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Map)","size":{"name":"### size","description":"","param":"","returnValue":"**返回值** \n\nMap 对象的成员数量。","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"clear":{"name":"### clear()","description":"\n移除 Map 对象中的所有元素。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"delete":{"name":"### delete(key)","description":"\n用于移除 Map 对象中指定的元素。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | K | 是 | - | - | 要从 Map 对象中删除的元素的键。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果 Map 对象中的元素存在并已被移除，则为 true；如果该元素不存在，则为 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach":{"name":"### forEach(callbackfn, thisArg?)","description":"\n按照插入顺序依次对 Map 中每个键/值对执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: any, key: any, map: [Map\\](#map-values)) => void | 是 | - | - | Map 中每个元素所要执行的函数。它具有如下的参数： value: 每个迭代的值。 key: 每个迭代的键。 map: 正在迭代的 Map。 |\n| thisArg | any | 否 | - | - | 在 callbackfn 执行中使用的 this 的值。 | \n\n##### Map\\ 的属性值 @map-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| size | number | 是 | - | | |\n\n##### Map\\ 的方法 @map-values \n\n##### clear() @clear\n\n移除 Map 对象中的所有元素。\n\n\n###### clear 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/map.html#clear)\n\n##### delete(key) @delete\n\n用于移除 Map 对象中指定的元素。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | any | 是 | - | - | 要从 Map 对象中删除的元素的键。 | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n###### delete 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/map.html#delete)\n\n##### forEach(callbackfn, thisArg?) @foreach\n\n按照插入顺序依次对 Map 中每个键/值对执行一次给定的函数。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: any, key: any, map: [Map\\](#map-values)) => void | 是 | - | - | Map 中每个元素所要执行的函数。它具有如下的参数： value: 每个迭代的值。 key: 每个迭代的键。 map: 正在迭代的 Map。 |\n| thisArg | any | 否 | - | - | 在 callbackfn 执行中使用的 this 的值。 | \n\n\n###### forEach 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/map.html#forEach)\n\n##### get(key) @get\n\n从 Map 对象返回指定的元素。如果与所提供的键相关联的值是一个对象，那么你将获得该对象的引用，对该对象所做的任何更改都会有效地在 Map 对象中修改它。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | any | 是 | - | - | 从 Map 对象返回的元素的键。 | \n\n###### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| any \\| null | 否 |\n \n\n###### get 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/map.html#get)\n\n##### has(key) @has\n\n返回一个布尔值，指示具有指定键的元素是否存在。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | any | 是 | - | - | 用于测试 Map 对象中是否存在的元素的键。 | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n###### has 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/map.html#has)\n\n##### set(key, value) @set\n\n为 Map 对象添加或更新一个指定了键（key）和值（value）的（新）键值对。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | any | 是 | - | - | 要添加到 Map 对象的元素的键。该值可以是任何数据类型（任何原始值或任何类型的对象）。 |\n| value | any | 是 | - | - | 要添加到 Map 对象的元素的值。该值可以是任何数据类型（任何原始值或任何类型的对象）。 | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n###### set 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/map.html#set)\n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach_1":{"name":"### forEach(callbackfn, thisArg?)","description":"\n按照插入顺序依次对 Map 中每个键/值对执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: any, key: any) => void | 是 | - | - | Map 中每个元素所要执行的函数。它具有如下的参数： value: 每个迭代的值。 key: 每个迭代的键。 |\n| thisArg | any | 否 | - | - | 在 callbackfn 执行中使用的 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach_2":{"name":"### forEach(callbackfn, thisArg?)","description":"\n按照插入顺序依次对 Map 中每个键/值对执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: any) => void | 是 | - | - | Map 中每个元素所要执行的函数。它具有如下的参数： value: 每个迭代的值。 |\n| thisArg | any | 否 | - | - | 在 callbackfn 执行中使用的 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"get":{"name":"### get(key)","description":"\n从 Map 对象返回指定的元素。如果与所提供的键相关联的值是一个对象，那么你将获得该对象的引用，对该对象所做的任何更改都会有效地在 Map 对象中修改它。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | K | 是 | - | - | 从 Map 对象返回的元素的键。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| V \\| null | 与指定键相关联的元素，如果键在 Map 对象中找不到，则返回 null。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"has":{"name":"### has(key)","description":"\n返回一个布尔值，指示具有指定键的元素是否存在。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | K | 是 | - | - | 用于测试 Map 对象中是否存在的元素的键。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果 Map 对象中存在具有指定键的元素，则返回 true；否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"set":{"name":"### set(key, value)","description":"\n为 Map 对象添加或更新一个指定了键（key）和值（value）的（新）键值对。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | K | 是 | - | - | 要添加到 Map 对象的元素的键。该值可以是任何数据类型（任何原始值或任何类型的对象）。 |\n| value | V | 是 | - | - | 要添加到 Map 对象的元素的值。该值可以是任何数据类型（任何原始值或任何类型的对象）。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| this | Map 对象 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"}},"Set":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Set)","size":{"name":"### size","description":"\n返回 Set 对象中（唯一的）元素的个数。","param":"","returnValue":"**返回值** \n\n返回 Set 对象中（唯一的）元素的个数。","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"add":{"name":"### add(value)","description":"\n如果 Set 对象中没有具有相同值的元素，则 add() 方法将插入一个具有指定值的新元素到 Set 对象中。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | T | 是 | - | - | 要添加到 Set 对象的元素的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| this | Set 对象本身。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"clear":{"name":"### clear()","description":"\n移除 Set 对象中所有元素。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"delete":{"name":"### delete(value)","description":"\n从 Set 对象中删除指定的值（如果该值在 Set 中）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | T | 是 | - | - | 要从 Set 中移除的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 成功删除返回 true，否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach":{"name":"### forEach(callbackfn, thisArg?)","description":"\n对 Set 对象中的每个值按插入顺序执行一次提供的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T, value2: T, set: [Set\\](#set-values)) => void | 是 | - | - | 为集合中每个元素执行的回调函数，该函数接收三个参数：value、key: Set 中正在处理的当前元素。因为 Set 中没有键，所以 value 会被共同传递给这两个参数。set: 调用 forEach() 的 Set 对象。 |\n| thisArg | any | 否 | - | - | 值在执行 callbackFn 时作为 this 使用。 | \n\n##### Set\\ 的属性值 @set-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| size | number | 是 | - | | 返回 Set 对象中（唯一的）元素的个数。 |\n\n##### Set\\ 的方法 @set-values \n\n##### add(value) @add\n\n如果 Set 对象中没有具有相同值的元素，则 add() 方法将插入一个具有指定值的新元素到 Set 对象中。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | T | 是 | - | - | 要添加到 Set 对象的元素的值。 | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n###### add 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/Set.html#add)\n\n##### clear() @clear\n\n移除 Set 对象中所有元素。\n\n\n###### clear 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/Set.html#clear)\n\n##### delete(value) @delete\n\n从 Set 对象中删除指定的值（如果该值在 Set 中）。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | T | 是 | - | - | 要从 Set 中移除的值。 | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n###### delete 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/Set.html#delete)\n\n##### forEach(callbackfn, thisArg?) @foreach\n\n对 Set 对象中的每个值按插入顺序执行一次提供的函数。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T, value2: T, set: [Set\\](#set-values)) => void | 是 | - | - | 为集合中每个元素执行的回调函数，该函数接收三个参数：value、key: Set 中正在处理的当前元素。因为 Set 中没有键，所以 value 会被共同传递给这两个参数。set: 调用 forEach() 的 Set 对象。 |\n| thisArg | any | 否 | - | - | 值在执行 callbackFn 时作为 this 使用。 | \n\n\n###### forEach 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/Set.html#forEach)\n\n##### has(value) @has\n\n返回一个布尔值来指示对应的值是否存在于 Set 对象中。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | T | 是 | - | - | 要测试是否存在于 Set 对象中的值。 | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n###### has 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/Set.html#has)\n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach_1":{"name":"### forEach(callbackfn, thisArg?)","description":"\n对 Set 对象中的每个值按插入顺序执行一次提供的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T, value2: T) => void | 是 | - | - | 为集合中每个元素执行的回调函数，该函数接收两个参数：value、key。 |\n| thisArg | any | 否 | - | - | 值在执行 callbackFn 时作为 this 使用。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach_2":{"name":"### forEach(callbackfn, thisArg?)","description":"\n对 Set 对象中的每个值按插入顺序执行一次提供的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T) => void | 是 | - | - | 为集合中每个元素执行的回调函数，该函数接收一个参数：value。 |\n| thisArg | any | 否 | - | - | 值在执行 callbackFn 时作为 this 使用。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"has":{"name":"### has(value)","description":"\n返回一个布尔值来指示对应的值是否存在于 Set 对象中。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | T | 是 | - | - | 要测试是否存在于 Set 对象中的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果 Set 对象中存在具有指定值的元素，则返回 true；否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"}},"Promise":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Promise)","Constructor":{"name":"### Constructor(fn)","description":"\n创建一个新的 Promise 对象。该构造函数主要用于封装还没有添加 promise 支持的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| fn | (resolve: (value: T) => void, reject: (reason?: any \\| null) => void) => void | 是 | - | - | 在构造函数中执行的 function。 | \n","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"Constructor_1":{"name":"### Constructor(fn)","description":"\n创建一个新的 Promise 对象。该构造函数主要用于封装还没有添加 promise 支持的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| fn | (resolve: (value: T) => void) => void | 是 | - | - | 在构造函数中执行的 function。 | \n","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"then":{"name":"### then()","description":"\n将一个兑现处理器和拒绝处理器附加到 Promise 上，并返回一个新的 Promise，解决为调用处理器得到的返回值，或者如果 Promise 没有被处理（即相关处理器 onFulfilled 或 onRejected 不是函数），则以原始敲定值解决。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"then_1":{"name":"### then(onFulfilled, onRejected?)","description":"\n将一个兑现处理器和拒绝处理器附加到 Promise 上，并返回一个新的 Promise，解决为调用处理器得到的返回值，或者如果 Promise 没有被处理（即相关处理器 onFulfilled 或 onRejected 不是函数），则以原始敲定值解决。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| onFulfilled | () => any | 是 | - | - | 一个在此 Promise 对象被兑现时异步执行的函数。它的返回值将成为 then() 返回的 Promise 对象的兑现值。 |\n| onRejected | (...args?: any) => any \\| null | 否 | - | - | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"then_2":{"name":"### then(onFulfilled, onRejected?)","description":"\n将一个兑现处理器和拒绝处理器附加到 Promise 上，并返回一个新的 Promise，解决为调用处理器得到的返回值，或者如果 Promise 没有被处理（即相关处理器 onFulfilled 或 onRejected 不是函数），则以原始敲定值解决。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| onFulfilled | () => Promise\\ | 是 | - | - | 一个在此 Promise 对象被兑现时异步执行的函数。它的返回值将成为 then() 返回的 Promise 对象的兑现值。 |\n| onRejected | (...args?: any) => any \\| null | 否 | - | - | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"then_3":{"name":"### then(onFulfilled, onRejected?)","description":"\n将一个兑现处理器和拒绝处理器附加到 Promise 上，并返回一个新的 Promise，解决为调用处理器得到的返回值，或者如果 Promise 没有被处理（即相关处理器 onFulfilled 或 onRejected 不是函数），则以原始敲定值解决。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| onFulfilled | (res: T) => any | 是 | - | - | 一个在此 Promise 对象被兑现时异步执行的函数。它的返回值将成为 then() 返回的 Promise 对象的兑现值。 |\n| onRejected | (...args?: any) => any \\| null | 否 | - | - | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"then_4":{"name":"### then(onFulfilled, onRejected?)","description":"\n将一个兑现处理器和拒绝处理器附加到 Promise 上，并返回一个新的 Promise，解决为调用处理器得到的返回值，或者如果 Promise 没有被处理（即相关处理器 onFulfilled 或 onRejected 不是函数），则以原始敲定值解决。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| onFulfilled | (res: T) => Promise\\ | 是 | - | - | 一个在此 Promise 对象被兑现时异步执行的函数。它的返回值将成为 then() 返回的 Promise 对象的兑现值。 |\n| onRejected | (...args?: any) => any \\| null | 否 | - | - | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"catch":{"name":"### catch()","description":"\n将一个拒绝处理回调函数附加到 Promise 上，并返回一个新的 Promise，如果回调被调用，则解决为回调的返回值，如果 Promise 被兑现，解决为其原始兑现值。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"catch_1":{"name":"### catch(onRejected)","description":"\n将一个拒绝处理回调函数附加到 Promise 上，并返回一个新的 Promise，如果回调被调用，则解决为回调的返回值，如果 Promise 被兑现，解决为其原始兑现值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| onRejected | () => any | 是 | - | - | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"catch_2":{"name":"### catch(onRejected)","description":"\n将一个拒绝处理回调函数附加到 Promise 上，并返回一个新的 Promise，如果回调被调用，则解决为回调的返回值，如果 Promise 被兑现，解决为其原始兑现值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| onRejected | () => Promise\\ | 是 | - | - | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"catch_3":{"name":"### catch(onRejected)","description":"\n将一个拒绝处理回调函数附加到 Promise 上，并返回一个新的 Promise，如果回调被调用，则解决为回调的返回值，如果 Promise 被兑现，解决为其原始兑现值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| onRejected | (res?: any \\| null) => any | 是 | - | - | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"catch_4":{"name":"### catch(onRejected)","description":"\n将一个拒绝处理回调函数附加到 Promise 上，并返回一个新的 Promise，如果回调被调用，则解决为回调的返回值，如果 Promise 被兑现，解决为其原始兑现值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| onRejected | (res?: any \\| null) => Promise\\ | 是 | - | - | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"finally":{"name":"### finally()","description":"\n将一个处理器附加到 Promise 上，并返回一个新的 Promise，当原始 Promise 被解决时解决。无论 Promise 是否被兑现还是被拒绝，处理器都会在 Promise 敲定时被调用。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| | (...args?: any) => any | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"resolve":{"name":"### resolve()","description":"\n返回一个新的 Promise 对象，该对象以给定的值兑现。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"resolve_1":{"name":"### resolve(value)","description":"\n返回一个新的 Promise 对象，该对象以给定的值兑现。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | T \\| null | 否 | - | - | 一个兑现的值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"resolve_2":{"name":"### resolve(value)","description":"\n返回一个新的 Promise 对象，该对象以给定的值兑现。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | Promise\\ \\| null | 否 | - | - | 一个 Promise。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"reject":{"name":"### reject(value?)","description":"\n返回一个新的 Promise 对象，该对象以给定的原因拒绝。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | any \\| null | 否 | - | - | 一个拒绝的原因。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"all":{"name":"### all(arr)","description":"\n接受一个 Promise 可迭代对象作为输入，并返回单个 Promise。返回的 Promise 在所有输入的 Promise 都兑现时（包括传入的可迭代对象为空时）被兑现，其值为一个包含所有兑现值的数组。如果输入的任何 Promise 被拒绝，返回的 Promise 也会被拒绝，并返回第一个拒绝的原因。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arr | Array\\\\> | 是 | - | - | 一个 Promise 数组。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\> | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"race":{"name":"### race(arr)","description":"\n接受一个 Promise 可迭代对象作为输入，并返回单个 Promise。返回的 Promise 与第一个敲定的 Promise 的最终状态保持一致。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arr | Array\\\\> | 是 | - | - | 一个 Promise 数组。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"any":{"name":"### any(arr)","description":"\n接受一个 Promise 可迭代对象作为输入，并返回单个 Promise。返回的 Promise 在任何输入的 Promise 兑现时兑现，其值为第一个兑现的值。如果所有输入的 Promise 都被拒绝（包括传入的可迭代对象为空时），返回的 Promise 将以带有一个包含拒绝原因的数组的 AggregateError 拒绝。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arr | Array\\\\> | 是 | - | - | 一个 Promise 数组。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"allSettled":{"name":"### allSettled(arr)","description":"\n接受一个 Promise 可迭代对象作为输入，并返回单个 Promise。返回的 Promise 在所有输入的 Promise 都敲定时兑现（包括传入的可迭代对象为空时），其值为一个描述每个 Promise 结果的对象数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arr | Array\\\\> | 是 | - | - | 一个 Promise 数组。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\>> | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"}},"UTSJSONObject":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.UTSJSONObject)","get":{"name":"### get(key)","description":"\n获取一个 属性，返回类型是any 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| any\\|null | 如果属性存在返回结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"set":{"name":"### set(key, value)","description":"\n获取一个 属性，返回类型是any 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - |\n| value | any | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| void | 如果属性存在返回结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"getAny":{"name":"### getAny(key)","description":"\n获取一个 属性，返回类型是any 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| any\\|null | 如果属性存在返回结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"getBoolean":{"name":"### getBoolean(key)","description":"\n获取一个Boolean属性，返回类型是Boolean 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean\\|null | 如果属性名存在，且类型为Boolean返回对应的结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"getNumber":{"name":"### getNumber(key)","description":"\n获取一个number属性，返回类型是number 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number\\|null | 如果属性名存在，且类型为number返回对应的结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"getString":{"name":"### getString(key)","description":"\n获取一个string属性，返回类型是string 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string\\|null | 如果属性名存在，且类型为string返回对应的结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"getJSON":{"name":"### getJSON(key)","description":"\n获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UTSJSONObject\\|null | 如果属性名存在，且类型为UTSJSONObject返回对应的结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"getArray":{"name":"### getArray(key)","description":"\n获取一个Array属性，返回类型是Array 或者 null, 数组元素类型由泛型T决定","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Array\\\\|null | 如果属性名存在，且类型为Array返回对应的结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"getArray_1":{"name":"### getArray(key)","description":"\n获取一个Array属性，返回类型是Array 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Array\\\\|null | 如果属性名存在，且类型为Array返回对应的结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"toMap":{"name":"### toMap()","description":"\n将当前 UTSJSONObject 实例转换为 Map 实例。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Map\\ | 返回 Map\\ 类型的 map | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"}},"Console":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Console)","assert":{"name":"### assert(condition?, ...data)","description":"\n如果断言为 false，则将一个错误消息写入控制台。如果断言是 true，没有任何反应。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| condition | boolean | 是 | - | - | - |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"clear":{"name":"### clear()","description":"\nconsole.clear() 方法清空控制台，但前提是该控制台允许清空。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"count":{"name":"### count(label?)","description":"\nconsole.count() 方法会记录调用 count() 的次数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| label | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"countReset":{"name":"### countReset(label?)","description":"\n重置计数器。此函数有一个可选参数 label。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| label | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"debug":{"name":"### debug(...data)","description":"\n在控制台打印 debug 日志","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"dir":{"name":"### dir(item?, options?)","description":"\nconsole.dir() 方法可以显示指定 JavaScript 对象的属性列表，并以交互式的形式展现。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| item | any \\| null | 否 | - | - | |\n| options | any \\| null | 否 | - | - | | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"dirxml":{"name":"### dirxml(...data)","description":"\n显示一个明确的 XML/HTML 元素的包括所有后代元素的交互树。\n非标准: 该特性是非标准的，请尽量不要在生产环境中使用它！","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"error":{"name":"### error(...data)","description":"\n在控制台打印 error 日志","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"group":{"name":"### group(...data)","description":"\nconsole.group() 方法在控制台上创建一个新的分组。随后输出到控制台上的内容都会被添加一个缩进，表示该内容属于当前分组，直到调用 console.groupEnd() 之后，当前分组结束。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"groupCollapsed":{"name":"### groupCollapsed(...data)","description":"\nconsole.groupCollapsed() 方法在控制台上创建一个新的分组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"groupEnd":{"name":"### groupEnd()","description":"\n在控制台中退出一格缩进 (结束分组).","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"info":{"name":"### info(...data)","description":"\n在控制台打印 info 日志","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"log":{"name":"### log(...data)","description":"\n在控制台打印 log 日志","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"table":{"name":"### table(tabularData?, properties?)","description":"\n将数据以表格的形式显示。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tabularData | any \\| null | 否 | - | - | |\n| properties | string[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"time":{"name":"### time(label?)","description":"\n你可以启动一个计时器来跟踪某一个操作的占用时长。每一个计时器必须拥有唯一的名字，页面中最多能同时运行 10,000 个计时器。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| label | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"timeEnd":{"name":"### timeEnd(label?)","description":"\n停止一个通过 console.time() 启动的计时器\n非标准: 该特性是非标准的，请尽量不要在生产环境中使用它！","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| label | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"timeLog":{"name":"### timeLog(label?, ...data)","description":"\n在控制台输出计时器的值，该计时器必须已经通过 console.time() 启动。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| label | string | 是 | - | - | - |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"timeStamp":{"name":"### timeStamp(label?)","description":"\n非标准: 该特性是非标准的，请尽量不要在生产环境中使用它！","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| label | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"trace":{"name":"### trace(...data)","description":"\n向控制台 输出一个堆栈跟踪。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"warn":{"name":"### warn(...data)","description":"\n在控制台打印 warn 日志","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"}},"Global":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods)","eval":{"name":"### eval(x)","description":"\neval() 函数会将传入的字符串当做 JavaScript 代码进行执行。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | string | 是 | - | - | 一个表示 JavaScript 表达式、语句或一系列语句的字符串。表达式可以包含变量与已存在对象的属性。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| any | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.eval)"},"parseInt":{"name":"### parseInt(string, radix?)","description":"\nparseInt(string, radix) 解析一个字符串并返回指定基数的十进制整数，radix 是 2-36 之间的整数，表示被解析字符串的基数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| string | string | 是 | - | - | 要被解析的值。字符串开头的空白符将会被忽略。（注意：只接收字符串类型的参数，其他类型将编译报错。） |\n| radix | number | 是 | - | - | 从 2 到 36 的整数，表示进制的基数。例如指定 16 表示被解析值是十六进制数。如果超出这个范围，将返回 NaN。假如指定 0 或未指定，基数将会根据字符串的值进行推算。注意，推算的结果不会永远是默认值 10！ | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 从给定的字符串中解析出的一个整数，或者 NaN。当radix 小于 2 或大于 36，或第一个非空格字符不能转换为数字时返回 NAN。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.parseInt)"},"parseFloat":{"name":"### parseFloat(string)","description":"\nparseFloat() 函数解析一个参数（直接收字符串类型的参数，其他类型编译报错）并返回一个浮点数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| string | string | 是 | - | - | 需要被解析成为浮点数的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 给定值被解析成浮点数。如果给定值不能被转换成数值，则会返回 NaN。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.parseFloat)"},"isNaN":{"name":"### isNaN(number)","description":"\nisNaN() 函数用来确定一个值是否为NaN 。注：isNaN函数内包含一些非常有趣的规则；你也可以使用 ECMAScript 2015 中定义的 Number.isNaN() 来判断。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| number | number | 是 | - | - | 要被检测的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果给定值为 NaN则返回值为true；否则为false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.isNaN)"},"isFinite":{"name":"### isFinite(number)","description":"\nisFinite() 函数用来判断被传入的参数值是否为一个有限数值（finite number）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| number | number | 是 | - | - | 要被检测的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果参数是 NaN，正无穷大或者负无穷大，会返回false，其他返回 true。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.isFinite)"},"decodeURI":{"name":"### decodeURI(encodedURI)","description":"\ndecodeURI() 函数能解码由encodeURI 创建或其他流程得到的统一资源标识符（URI）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| encodedURI | string | 是 | - | - | 一个完整的编码过的 URI | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个给定编码统一资源标识符 (URI) 的未编码版本的新字符串, 当 encodedURI 包含无效字符序列时，会返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.91 | 4.11 | 4.0 | 3.91 | 3.91 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.decodeURI)"},"decodeURIComponent":{"name":"### decodeURIComponent(encodedURIComponent)","description":"\ndecodeURIComponent() 方法用于解码由 encodeURIComponent 方法或者其他类似方法编码的部分统一资源标识符（URI）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| encodedURIComponent | string | 是 | - | - | 编码后的部分 URI | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个解码后的统一资源标识符（URI）字符串，处理前的 URI 经过了给定格式的编码。当 encodedURI 包含无效字符序列时，会返回null. | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.91 | 4.11 | 4.0 | 3.91 | 3.91 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.decodeURIComponent)"},"encodeURI":{"name":"### encodeURI(uri)","description":"\nencodeURI() 函数通过将特定字符的每个实例替换为一个、两个、三或四转义序列来对统一资源标识符 (URI) 进行编码 (该字符的 UTF-8 编码仅为四转义序列) 由两个 \"代理\" 字符组成)。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| uri | string | 是 | - | - | 一个完整的 URI。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个新字符串，表示提供的字符串编码为统一资源标识符 (URI)。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.91 | 4.11 | 4.0 | 3.91 | 3.91 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.encodeURI)"},"encodeURIComponent":{"name":"### encodeURIComponent(uriComponent)","description":"\nencodeURIComponent() 函数通过将特定字符的每个实例替换成代表字符的 UTF-8 编码的一个、两个、三个或四个转义序列来编码 URI（只有由两个“代理”字符组成的字符会被编码为四个转义序列）。与 encodeURI() 相比，此函数会编码更多的字符，包括 URI 语法的一部分。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| uriComponent | string | 是 | - | - | 要被检测的 string 值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 原字串作为 URI 组成部分被被编码后的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.91 | 4.11 | 4.0 | 3.91 | 3.91 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.encodeURIComponent)"},"setInterval":{"name":"### setInterval(handler, timeout?, ...arguments)","description":"\nsetInterval() 方法重复调用一个函数或执行一个代码片段，在每次调用之间具有固定的时间间隔。\n它返回一个 interval ID，该 ID 唯一地标识时间间隔，因此你可以稍后通过调用 clearInterval() 来移除定时器。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| handler | string \\| Function | 是 | - | - | - |\n| timeout | number | 是 | - | - | - |\n| arguments | any[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9 | 3.9 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.setInterval)"},"setTimeout":{"name":"### setTimeout(handler, timeout?, ...arguments)","description":"\n全局的 setTimeout() 方法设置一个定时器，一旦定时器到期，就会执行一个函数或指定的代码片段。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| handler | string \\| Function | 是 | - | - | - |\n| timeout | number | 是 | - | - | - |\n| arguments | any[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9 | 3.9 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.setTimeout)"},"clearInterval":{"name":"### clearInterval(id)","description":"\nclearInterval() 方法可取消先前通过 setInterval() 设置的重复定时任务。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| id | number \\| undefined | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9 | 3.9 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.clearInterval)"},"clearTimeout":{"name":"### clearTimeout(id)","description":"\nclearTimeout() 方法取消了先前通过调用setTimeout()建立的定时器","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| id | number \\| undefined | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9 | 3.9 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.clearTimeout)"}},"Timers":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods)","eval":{"name":"### eval(x)","description":"\neval() 函数会将传入的字符串当做 JavaScript 代码进行执行。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | string | 是 | - | - | 一个表示 JavaScript 表达式、语句或一系列语句的字符串。表达式可以包含变量与已存在对象的属性。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| any | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.eval)"},"parseInt":{"name":"### parseInt(string, radix?)","description":"\nparseInt(string, radix) 解析一个字符串并返回指定基数的十进制整数，radix 是 2-36 之间的整数，表示被解析字符串的基数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| string | string | 是 | - | - | 要被解析的值。字符串开头的空白符将会被忽略。（注意：只接收字符串类型的参数，其他类型将编译报错。） |\n| radix | number | 是 | - | - | 从 2 到 36 的整数，表示进制的基数。例如指定 16 表示被解析值是十六进制数。如果超出这个范围，将返回 NaN。假如指定 0 或未指定，基数将会根据字符串的值进行推算。注意，推算的结果不会永远是默认值 10！ | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 从给定的字符串中解析出的一个整数，或者 NaN。当radix 小于 2 或大于 36，或第一个非空格字符不能转换为数字时返回 NAN。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.parseInt)"},"parseFloat":{"name":"### parseFloat(string)","description":"\nparseFloat() 函数解析一个参数（直接收字符串类型的参数，其他类型编译报错）并返回一个浮点数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| string | string | 是 | - | - | 需要被解析成为浮点数的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 给定值被解析成浮点数。如果给定值不能被转换成数值，则会返回 NaN。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.parseFloat)"},"isNaN":{"name":"### isNaN(number)","description":"\nisNaN() 函数用来确定一个值是否为NaN 。注：isNaN函数内包含一些非常有趣的规则；你也可以使用 ECMAScript 2015 中定义的 Number.isNaN() 来判断。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| number | number | 是 | - | - | 要被检测的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果给定值为 NaN则返回值为true；否则为false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.isNaN)"},"isFinite":{"name":"### isFinite(number)","description":"\nisFinite() 函数用来判断被传入的参数值是否为一个有限数值（finite number）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| number | number | 是 | - | - | 要被检测的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果参数是 NaN，正无穷大或者负无穷大，会返回false，其他返回 true。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.isFinite)"},"decodeURI":{"name":"### decodeURI(encodedURI)","description":"\ndecodeURI() 函数能解码由encodeURI 创建或其他流程得到的统一资源标识符（URI）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| encodedURI | string | 是 | - | - | 一个完整的编码过的 URI | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个给定编码统一资源标识符 (URI) 的未编码版本的新字符串, 当 encodedURI 包含无效字符序列时，会返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.91 | 4.11 | 4.0 | 3.91 | 3.91 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.decodeURI)"},"decodeURIComponent":{"name":"### decodeURIComponent(encodedURIComponent)","description":"\ndecodeURIComponent() 方法用于解码由 encodeURIComponent 方法或者其他类似方法编码的部分统一资源标识符（URI）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| encodedURIComponent | string | 是 | - | - | 编码后的部分 URI | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个解码后的统一资源标识符（URI）字符串，处理前的 URI 经过了给定格式的编码。当 encodedURI 包含无效字符序列时，会返回null. | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.91 | 4.11 | 4.0 | 3.91 | 3.91 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.decodeURIComponent)"},"encodeURI":{"name":"### encodeURI(uri)","description":"\nencodeURI() 函数通过将特定字符的每个实例替换为一个、两个、三或四转义序列来对统一资源标识符 (URI) 进行编码 (该字符的 UTF-8 编码仅为四转义序列) 由两个 \"代理\" 字符组成)。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| uri | string | 是 | - | - | 一个完整的 URI。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个新字符串，表示提供的字符串编码为统一资源标识符 (URI)。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.91 | 4.11 | 4.0 | 3.91 | 3.91 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.encodeURI)"},"encodeURIComponent":{"name":"### encodeURIComponent(uriComponent)","description":"\nencodeURIComponent() 函数通过将特定字符的每个实例替换成代表字符的 UTF-8 编码的一个、两个、三个或四个转义序列来编码 URI（只有由两个“代理”字符组成的字符会被编码为四个转义序列）。与 encodeURI() 相比，此函数会编码更多的字符，包括 URI 语法的一部分。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| uriComponent | string | 是 | - | - | 要被检测的 string 值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 原字串作为 URI 组成部分被被编码后的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.91 | 4.11 | 4.0 | 3.91 | 3.91 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.encodeURIComponent)"},"setInterval":{"name":"### setInterval(handler, timeout?, ...arguments)","description":"\nsetInterval() 方法重复调用一个函数或执行一个代码片段，在每次调用之间具有固定的时间间隔。\n它返回一个 interval ID，该 ID 唯一地标识时间间隔，因此你可以稍后通过调用 clearInterval() 来移除定时器。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| handler | string \\| Function | 是 | - | - | - |\n| timeout | number | 是 | - | - | - |\n| arguments | any[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9 | 3.9 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.setInterval)"},"setTimeout":{"name":"### setTimeout(handler, timeout?, ...arguments)","description":"\n全局的 setTimeout() 方法设置一个定时器，一旦定时器到期，就会执行一个函数或指定的代码片段。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| handler | string \\| Function | 是 | - | - | - |\n| timeout | number | 是 | - | - | - |\n| arguments | any[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9 | 3.9 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.setTimeout)"},"clearInterval":{"name":"### clearInterval(id)","description":"\nclearInterval() 方法可取消先前通过 setInterval() 设置的重复定时任务。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| id | number \\| undefined | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9 | 3.9 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.clearInterval)"},"clearTimeout":{"name":"### clearTimeout(id)","description":"\nclearTimeout() 方法取消了先前通过调用setTimeout()建立的定时器","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| id | number \\| undefined | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9 | 3.9 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.clearTimeout)"}},"UTSAndroid":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UTSAndroid)","onAppConfigChange":{"name":"### onAppConfigChange(callback)","description":"\n监听 App配置发生变化, 对应 android原生 onAppConfigChange","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: UTSJSONObject) => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"offAppConfigChange":{"name":"### offAppConfigChange(callback?)","description":"\nonAppConfigChange 对应的反注册函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: UTSJSONObject) => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"onAppTrimMemory":{"name":"### onAppTrimMemory(callback?)","description":"\n注册监听 App 内存不足时的系统回调函数 对应原生的API: onTrimMemory","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: Number) => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"offAppTrimMemory":{"name":"### offAppTrimMemory(callback?)","description":"\nonAppTrimMemory 对应的反注册函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: Number) => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"onAppActivityPause":{"name":"### onAppActivityPause(callback)","description":"\n注册监听 activity onPause事件","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"offAppActivityPause":{"name":"### offAppActivityPause(callback?)","description":"\nonAppActivityPause 对应的反注册函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"onAppActivityResume":{"name":"### onAppActivityResume(callback)","description":"\n注册监听 activity onResume事件","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"offAppActivityResume":{"name":"### offAppActivityResume(callback?)","description":"\nonAppActivityResume 对应的反注册函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"onAppActivityDestroy":{"name":"### onAppActivityDestroy(callback)","description":"\n注册监听 activity onDestroy事件","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"offAppActivityDestroy":{"name":"### offAppActivityDestroy(callback?)","description":"\nonAppActivityDestroy 对应的反注册函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"onAppActivityResult":{"name":"### onAppActivityResult(callback)","description":"\n注册监听 activity onAppActivityResult 函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (requestCode: Int, resultCode: Int, data: any) => void | 是 | - | - | 用于监听的响应函数 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"offAppActivityResult":{"name":"### offAppActivityResult(callback?)","description":"\nonAppActivityResult 对应的反注册函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (requestCode: Int, resultCode: Int, data: any) => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"onAppActivityBack":{"name":"### onAppActivityBack(callback)","description":"\n注册监听 activity onAppActivityBack 函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | 用于监听的响应函数 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"offAppActivityBack":{"name":"### offAppActivityBack(callback?)","description":"\n取消注册监听 activity onAppActivityBack 函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getAppContext":{"name":"### getAppContext()","description":"\n获取当前应用Application上下文，对应android平台 Context.getApplicationContext 函数实现","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Context \\| null | 当前应用程序 上下文实例对象 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getUniActivity":{"name":"### getUniActivity()","description":"\n获取当前应用 栈顶的 Activity实例，对应android平台 getActivity 函数实现","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Activity \\| null | 当前应用栈顶的 Activity实例 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getTopPageActivity":{"name":"### getTopPageActivity()","description":"\n获取与当前页面绑定的activity对象，需要注意的是:当页面对象未与activity建立绑定关系时，可能为null","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Activity \\| null | 当前页面绑定的activity示例 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.0 | x | - | 4.0 | x | - |\n","itemType":"method"},"getResourcePath":{"name":"### getResourcePath(resourceName)","description":"\n获取资源文件的原生路径。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| resourceName | string | 是 | - | - | 资源文件相对于工程的绝对路径, 如：“/static/logo.png” | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 该资源在原生目录下的路径 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | √ | - |\n","itemType":"method"},"getJavaClass":{"name":"### getJavaClass(input)","description":"\n获取对象的jvm class实例","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| input | any | 是 | - | - | 任意不为空对象 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Class | 传入对象所对应的class实例 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.0 | x | - | 4.0 | x | - |\n","itemType":"method"},"getAppCachePath":{"name":"### getAppCachePath()","description":"\n获取app 临时目录。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string \\| null | 返回app临时目录路径。存放在该文件可能会在应用退出后被清理 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.99 | x | - | √ | x | - |\n","itemType":"method"},"exit":{"name":"### exit()","description":"\n退出当前应用","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getDispatcher":{"name":"### getDispatcher(threadName)","description":"\n获取一个任务分发器实例","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| threadName | string\\|null | 否 | - | - | 任务组名称，可能为：
main: ui thread / dom: 仅uni-app x环境生效，uni-app 环境会自动切换到 ui
io : io thread
匿名线程 null 或者 '': 来源线程，如果来源线程不支持任务分发，则会在当前线程执行执行. 这个场景下要求第一个参数必须是线程环境 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| [UTSTaskDispatcher](#utstaskdispatcher-values) | \n\n\n\n##### UTSTaskDispatcher 的方法 @utstaskdispatcher-values \n\n##### async(action, param?) @async\n\n在当前任务分发器 异步执行任务\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| action | (action?: any \\| null) => void | 是 | - | - | 任务函数 |\n| param | any \\| null | 否 | - | - | 任务函数需要的参数 | \n\n\n###### async 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getAppId":{"name":"### getAppId()","description":"\n获取当前运行的app的AppId。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 当前运行的app的AppId。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getOsTheme":{"name":"### getOsTheme()","description":"\n获取当前系统主题样式","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 系统主题样式 \"dark\":暗色模式 \"light\":亮色模式 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"isUniMp":{"name":"### isUniMp()","description":"\n获取当前运行环境是否是unimp。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 是否是unimp。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getAppName":{"name":"### getAppName()","description":"\n获取manifest.json 中配置的应用名称","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 应用名称。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getAppVersion":{"name":"### getAppVersion()","description":"\n获取manifest.json 中配置的应用版本信息","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UTSJSONObject | 应用版本信息 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getInnerVersion":{"name":"### getInnerVersion()","description":"\n获取引擎版本号。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 引擎版本号。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"isUniAppX":{"name":"### isUniAppX()","description":"\n获取当前是否是uniapp x 环境","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | uniapp x 环境 true, uniapp 环境： false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"rpx2px":{"name":"### rpx2px(rpx)","description":"","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| rpx | number | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回对应的逻辑像素值 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"rpx2px_1":{"name":"### rpx2px(rpx)","description":"\n页面的rpx像素转换为页面的px像素","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| rpx | number | 是 | - | - | 待转换的rpx | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 转换后的px | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.95 | x | - | 3.95 | x | - |\n","itemType":"method"},"isPrivacyAgree":{"name":"### isPrivacyAgree()","description":"\n当前应用是否已取得用户同意隐私协议","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | true 用户已同意 false 用户未同意 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"setPrivacyAgree":{"name":"### setPrivacyAgree(state)","description":"\n设置当前应用是否已取得用户同意隐私协议","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| state | boolean | 是 | - | - | true 用户已同意 false 用户未同意 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"resetPrivacyAgree":{"name":"### resetPrivacyAgree()","description":"\n重置当前应用至用户未同意隐私协议","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"requestSystemPermission":{"name":"### requestSystemPermission(context, requestPermission, success, fail)","description":"\n请求系统权限","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| context | Activity | 是 | - | - | - |\n| requestPermission | Array\\\\ | 是 | - | - | 期望请求的权限 |\n| success | (allRight: boolean, grantedList: Array\\) => void | 是 | - | - | - |\n| fail | (doNotAskAgain: boolean, grantedList: Array\\) => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"checkSystemPermissionGranted":{"name":"### checkSystemPermissionGranted(context, requestPermission)","description":"\n检查当前应用是否已经具备指定权限","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| context | Activity | 是 | - | - | - |\n| requestPermission | Array\\\\ | 是 | - | - | 期望具备的权限 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 请求的权限列表中是否已经具备 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"gotoSystemPermissionActivity":{"name":"### gotoSystemPermissionActivity(context, requestPermission)","description":"\n跳转至系统权限手动设备列表","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| context | Activity | 是 | - | - | - |\n| requestPermission | Array\\\\ | 是 | - | - | 期望请求的权限 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"getSystemPermissionDenied":{"name":"### getSystemPermissionDenied(context, requestPermission)","description":"\n获取当前应用不具备的权限列表","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| context | Activity | 是 | - | - | - |\n| requestPermission | Array\\\\ | 是 | - | - | 期望请求的权限 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Array\\ | 请求的权限列表中已经被禁用的部分 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"devicePX2px":{"name":"### devicePX2px(devicePX)","description":"\n物理像素转换为页面的px像素","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| devicePX | number | 是 | - | - | 待转换的物理像素 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 转换后的页面px | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.95 | x | - | 3.95 | x | - |\n","itemType":"method"},"convert2AbsFullPath":{"name":"### convert2AbsFullPath(inputPath)","description":"\n将文件的项目相对地址转换为 运行期对应的绝对地址\neg.\n 'static/logo.png' -> '/storage/sdcard/0/apps/com.xxxx/files/logo.png'\n","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| inputPath | string | 是 | - | - | 待转换的文件相对路径 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 转换后文件绝对路径 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9 | x | - |\n","itemType":"method"},"getFileProviderUri":{"name":"### getFileProviderUri(file)","description":"\n将应用的私有文件 通过内置的FileProvider转换为外部应用可以访问的Uri\n","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| file | File | 是 | - | - | 待转换的私有文件 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Uri | 转换后的Uri | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.99 | x | - | 3.99 | x | - |\n","itemType":"method"},"getExtApiProvider":{"name":"### getExtApiProvider(service, providerName)","description":"\n获取指定service的指定provider实现\n","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| service | string | 是 | - | - | 指定的服务名称 |\n| providerName | string | 是 | - | - | 指定provider名称 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T \\| null | 指定 provider 实例 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.14 | x | - | 4.14 | x | - |\n","itemType":"method"},"onPrivacyAgreeChange":{"name":"### onPrivacyAgreeChange(callback)","description":"\n注册隐私协议更改回调\n","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (option: [PrivacyOption](#privacyoption-values)) => void | 是 | - | - | 回调方法 | \n\n##### PrivacyOption 的属性值 @privacyoption-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| isAgree | boolean | 是 | - | - | 是否同意用户隐私协议 |\n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | 4.18 | x | - |\n","itemType":"method"},"offPrivacyAgreeChange":{"name":"### offPrivacyAgreeChange(callback)","description":"\n移除隐私协议更改回调\n","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (option: [PrivacyOption](#privacyoption-values)) => void | 是 | - | - | onPrivacyAgreeChange中传入的callback | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | 4.18 | x | - |\n","itemType":"method"},"onActivityCallback":{"name":"### onActivityCallback(callback, pageRoute?)","description":"\n注册activity回调方法\n","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | IUniActivityCallback | 是 | - | - | 回调方法，[查看具体子类实现](https://doc.dcloud.net.cn/uni-app-x/uts/utsactivitycallback.html) |\n| pageRoute | string\\|null | 否 | - | - | [页面的路由地址route](https://doc.dcloud.net.cn/uni-app-x/api/get-current-pages.html#getcurrentpages) | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"offActivityCallback":{"name":"### offActivityCallback(callback)","description":"\n移除activity回调方法\n","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | IUniActivityCallback | 是 | - | - | onActivityCallback传入的callback | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"setAppTheme":{"name":"### setAppTheme(theme)","description":"\n设置app主题","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| theme | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onAppThemeChanged":{"name":"### onAppThemeChanged(callback)","description":"\n监听app主题变化","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: UTSJSONObject) => void | 是 | - | - | app主题变化回调函数 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"offAppThemeChanged":{"name":"### offAppThemeChanged(callbackId)","description":"\n注销app主题监听","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackId | number | 是 | - | - | callback监听id | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onOsThemeChanged":{"name":"### onOsThemeChanged(callback)","description":"\n监听系统主题变化","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: UTSJSONObject) => void | 是 | - | - | 主题变化回调函数 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"offOsThemeChanged":{"name":"### offOsThemeChanged(callbackId)","description":"\n注销系统主题监听","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackId | number | 是 | - | - | callback监听id | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"}},"UTSiOS":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UTSiOS)","getCurrentViewController":{"name":"### getCurrentViewController()","description":"\n获取当前 app 显示的 UIViewController。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UIViewController | 当前 app 显示的 UIViewController | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getKeyWindow":{"name":"### getKeyWindow()","description":"\n获取当前app的keyWindow。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UIWindow | 当前app的keyWindow. | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"colorWithString":{"name":"### colorWithString(value)","description":"\n获取指定的颜色。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | string | 是 | - | - | 需要转换的代表色值的字符串，支持一下格式：精简写法的十六进制 如：#f00，十六进制 如：#ff0000，RGB 如：rgb(255, 0, 0)，RGBA 如:rgba(255, 0, 0, 0.5)，色值关键字，如： red | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UIColor | UIColor 实例对象 注：如转换失败 默认会返回 黑色 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getResourcePath":{"name":"### getResourcePath(resourceName)","description":"\n获取H5资源文件的原生路径。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| resourceName | string | 是 | - | - | H5资源文件相对于工程的绝对路径, 如：“/static/logo.png” | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 该资源在原生目录下的路径 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"isSimulator":{"name":"### isSimulator()","description":"\n是否是模拟器。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 当前是模拟器 true, 当前是真机：false | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getDeviceId":{"name":"### getDeviceId()","description":"\n获取设备 deviceId。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 当前设备的 deviceId | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getModel":{"name":"### getModel()","description":"\n获取设备型号。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getUserAgent":{"name":"### getUserAgent()","description":"\n获取当前应用的 UserAgent。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 当前应用的 UserAgent。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getAppId":{"name":"### getAppId()","description":"\n获取当前运行的app的AppId。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 当前运行的app的AppId。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getDataPath":{"name":"### getDataPath()","description":"\n获取当前运行app的dataPath","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 当前运行app的dataPath。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"isUniMp":{"name":"### isUniMp()","description":"\n获取当前运行环境是否是unimp。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 是否是unimp。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getAppName":{"name":"### getAppName()","description":"\n获取manifest.json 中配置的应用名称","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 应用名称。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getAppVersion":{"name":"### getAppVersion()","description":"\n获取manifest.json 中配置的应用版本名称。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 应用版本名称。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getAppVersionCode":{"name":"### getAppVersionCode()","description":"\n获取manifest.json 中配置的应用版本号。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 应用版本号。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getOsLanguage":{"name":"### getOsLanguage()","description":"\n获取操作系统设置的语言。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | os language。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getAppWgtVersion":{"name":"### getAppWgtVersion()","description":"\n获取应用资源（wgt）的版本名称。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 应用资源（wgt）的版本名称。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getInnerVersion":{"name":"### getInnerVersion()","description":"\n获取引擎版本号。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 引擎版本号。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getSystemSetting":{"name":"### getSystemSetting()","description":"\n获取系统设置信息。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Map\\ | 系统设置信息。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"isBaseIpa":{"name":"### isBaseIpa()","description":"\n获取当前是否是基座环境。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 基座环境 true, 线上环境： false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getOsTheme":{"name":"### getOsTheme()","description":"\n获取系统当前主题。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 系统当前主题信息。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | √ | - |\n","itemType":"method"},"onOsThemeChange":{"name":"### onOsThemeChange(callback)","description":"\n监听系统主题变化（需要调用取消监听避免内存泄露）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (theme: string) => void | 是 | - | - | 监听函数 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 监听id。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | √ | - |\n","itemType":"method"},"offOsThemeChange":{"name":"### offOsThemeChange(callbackId)","description":"\n取消监听系统主题变化。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackId | number | 是 | - | - | 监听id | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | √ | - |\n","itemType":"method"},"getAppTheme":{"name":"### getAppTheme()","description":"\n获取App当前主题。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | App当前主题信息。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | √ | - |\n","itemType":"method"},"setAppTheme":{"name":"### setAppTheme(theme)","description":"\n设置App当前主题。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| theme | string | 是 | - | - | 要设置的主题信息 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| void | App当前主题信息。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | √ | - |\n","itemType":"method"},"onAppThemeChange":{"name":"### onAppThemeChange(callback)","description":"\n监听app theme变化（需要调用取消监听避免内存泄露）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (theme: string) => void | 是 | - | - | 监听函数 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 监听id。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | √ | - |\n","itemType":"method"},"offAppThemeChange":{"name":"### offAppThemeChange(callbackId)","description":"\n取消监听app theme变化。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackId | number | 是 | - | - | 监听id | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | √ | - |\n","itemType":"method"}},"UTSiOSHookProxy":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UTSiOSHookProxy)","onCreate":{"name":"### onCreate()","description":"\nuts 插件创建时的回调。\n此回调的准确时机对应于 OC 类的 load() 函数调用时机。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationDidFinishLaunchingWithOptions":{"name":"### applicationDidFinishLaunchingWithOptions(application?, launchOptions?)","description":"\n应用正常启动时 (不包括已在后台转到前台的情况)的回调函数。\n可以在此回调函数做一些初始化操作，比如初始依赖的SDK等。注意：不要在此回调函数里做耗时操作，以免影响 app 的启动速度。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| application | UIApplication | 是 | - | - | App 的 UIApplicationDelegate 对象。 |\n| launchOptions | Map\\ | 是 | - | - | 启动参数。默认值为 null (用户通过点击 push 通知启动应用时，该参数内会包含通知的信息) | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 返回一个 boolean 值，正常返回true。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"didRegisterForRemoteNotifications":{"name":"### didRegisterForRemoteNotifications(deviceToken?)","description":"\n远程通知注册成功时的回调函数。\n可以在此函数里将 deviceToken 发送给服务端。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| deviceToken | Data | 是 | - | - | 设备的推送令牌 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"didFailToRegisterForRemoteNotifications":{"name":"### didFailToRegisterForRemoteNotifications(error?)","description":"\n远程通知注册失败时的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| error | NSError | 是 | - | - | 失败的原因。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"didReceiveRemoteNotification":{"name":"### didReceiveRemoteNotification(userInfo?)","description":"\n应用收到远程通知时的回调函数。\n当应用在前台运行中，收到远程通知时(不会弹出系统通知界面)，会回调这个方法；当应用在后台状态时，点击push消息启动应用，也会回调这个方法；当应用完全没有启动时，点击push消息启动应用，就不会回调这个方法。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| userInfo | Map\\ | 是 | - | - | 收到的远程通知信息。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"didReceiveLocalNotification":{"name":"### didReceiveLocalNotification(notification?)","description":"\n应用收到本地通知时的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| notification | UILocalNotification | 是 | - | - | 接收到的本地通知 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationHandleOpenURL":{"name":"### applicationHandleOpenURL(application?, url?)","description":"\n通过 url scheme 方式唤起 app 时的回调函数。(iOS9 之前的系统回调此方法，iOS9 之后的系统请使用 applicationOpenURLOptions)","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| application | UIApplication | 是 | - | - | App 的 UIApplicationDelegate 对象。 |\n| url | [URL](#url-values) | 是 | - | - | 要打开的URL资源。该资源可以是网络资源或文件。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| hash | string | 是 | - | - | Gets and sets the fragment portion of the URL. ```js const myURL = new URL('https://example.org/foo#bar'); console.log(myURL.hash); // Prints #bar myURL.hash = 'baz'; console.log(myURL.href); // Prints https://example.org/foo#baz ``` Invalid URL characters included in the value assigned to the `hash` property are `percent-encoded`. The selection of which characters to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce. |\n@| host | string | 是 | - | - | Gets and sets the host portion of the URL. ```js const myURL = new URL('https://example.org:81/foo'); console.log(myURL.host); // Prints example.org:81 myURL.host = 'example.com:82'; console.log(myURL.href); // Prints https://example.com:82/foo ``` Invalid host values assigned to the `host` property are ignored. |\n@| hostname | string | 是 | - | - | Gets and sets the host name portion of the URL. The key difference between`url.host` and `url.hostname` is that `url.hostname` does _not_ include the port. ```js const myURL = new URL('https://example.org:81/foo'); console.log(myURL.hostname); // Prints example.org // Setting the hostname does not change the port myURL.hostname = 'example.com:82'; console.log(myURL.href); // Prints https://example.com:81/foo // Use myURL.host to change the hostname and port myURL.host = 'example.org:82'; console.log(myURL.href); // Prints https://example.org:82/foo ``` Invalid host name values assigned to the `hostname` property are ignored. |\n@| href | string | 是 | - | - | Gets and sets the serialized URL. ```js const myURL = new URL('https://example.org/foo'); console.log(myURL.href); // Prints https://example.org/foo myURL.href = 'https://example.com/bar'; console.log(myURL.href); // Prints https://example.com/bar ``` Getting the value of the `href` property is equivalent to calling {@link toString}. Setting the value of this property to a new value is equivalent to creating a new `URL` object using `new URL(value)`. Each of the `URL`object's properties will be modified. If the value assigned to the `href` property is not a valid URL, a `TypeError`will be thrown. |\n@| origin | string | 是 | - | - | Gets the read-only serialization of the URL's origin. ```js const myURL = new URL('https://example.org/foo/bar?baz'); console.log(myURL.origin); // Prints https://example.org ``` ```js const idnURL = new URL('https://測試'); console.log(idnURL.origin); // Prints https://xn--g6w251d console.log(idnURL.hostname); // Prints xn--g6w251d ``` |\n@| password | string | 是 | - | - | Gets and sets the password portion of the URL. ```js const myURL = new URL('https://abc:xyz@example.com'); console.log(myURL.password); // Prints xyz myURL.password = '123'; console.log(myURL.href); // Prints https://abc:123@example.com ``` Invalid URL characters included in the value assigned to the `password` property are `percent-encoded`. The selection of which characters to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce. |\n@| pathname | string | 是 | - | - | Gets and sets the path portion of the URL. ```js const myURL = new URL('https://example.org/abc/xyz?123'); console.log(myURL.pathname); // Prints /abc/xyz myURL.pathname = '/abcdef'; console.log(myURL.href); // Prints https://example.org/abcdef?123 ``` Invalid URL characters included in the value assigned to the `pathname`property are `percent-encoded`. The selection of which characters to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce. |\n@| port | string | 是 | - | - | Gets and sets the port portion of the URL. The port value may be a number or a string containing a number in the range`0` to `65535` (inclusive). Setting the value to the default port of the`URL` objects given `protocol` will result in the `port` value becoming the empty string (`''`). The port value can be an empty string in which case the port depends on the protocol/scheme: \\ Upon assigning a value to the port, the value will first be converted to a string using `.toString()`. If that string is invalid but it begins with a number, the leading number is assigned to `port`. If the number lies outside the range denoted above, it is ignored. ```js const myURL = new URL('https://example.org:8888'); console.log(myURL.port); // Prints 8888 // Default ports are automatically transformed to the empty string // (HTTPS protocol's default port is 443) myURL.port = '443'; console.log(myURL.port); // Prints the empty string console.log(myURL.href); // Prints https://example.org/ myURL.port = 1234; console.log(myURL.port); // Prints 1234 console.log(myURL.href); // Prints https://example.org:1234/ // Completely invalid port strings are ignored myURL.port = 'abcd'; console.log(myURL.port); // Prints 1234 // Leading numbers are treated as a port number myURL.port = '5678abcd'; console.log(myURL.port); // Prints 5678 // Non-integers are truncated myURL.port = 1234.5678; console.log(myURL.port); // Prints 1234 // Out-of-range numbers which are not represented in scientific notation // will be ignored. myURL.port = 1e10; // 10000000000, will be range-checked as described below console.log(myURL.port); // Prints 1234 ``` Numbers which contain a decimal point, such as floating-point numbers or numbers in scientific notation, are not an exception to this rule. Leading numbers up to the decimal point will be set as the URL's port, assuming they are valid: ```js myURL.port = 4.567e21; console.log(myURL.port); // Prints 4 (because it is the leading number in the string '4.567e21') ``` |\n@| protocol | string | 是 | - | - | Gets and sets the protocol portion of the URL. ```js const myURL = new URL('https://example.org'); console.log(myURL.protocol); // Prints https: myURL.protocol = 'ftp'; console.log(myURL.href); // Prints ftp://example.org/ ``` Invalid URL protocol values assigned to the `protocol` property are ignored. |\n@| search | string | 是 | - | - | Gets and sets the serialized query portion of the URL. ```js const myURL = new URL('https://example.org/abc?123'); console.log(myURL.search); // Prints ?123 myURL.search = 'abc=xyz'; console.log(myURL.href); // Prints https://example.org/abc?abc=xyz ``` Any invalid URL characters appearing in the value assigned the `search`property will be `percent-encoded`. The selection of which characters to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce. |\n@| searchParams | [URLSearchParams](#urlsearchparams-values) | 是 | - | - | Gets the `URLSearchParams` object representing the query parameters of the URL. This property is read-only but the `URLSearchParams` object it provides can be used to mutate the URL instance; to replace the entirety of query parameters of the URL, use the {@link search} setter. See `URLSearchParams` documentation for details. Use care when using `.searchParams` to modify the `URL` because, per the WHATWG specification, the `URLSearchParams` object uses different rules to determine which characters to percent-encode. For instance, the `URL` object will not percent encode the ASCII tilde (`~`) character, while `URLSearchParams` will always encode it: ```js const myUrl = new URL('https://example.org/abc?foo=~bar'); console.log(myUrl.search); // prints ?foo=~bar // Modify the URL via searchParams... myUrl.searchParams.sort(); console.log(myUrl.search); // prints ?foo=%7Ebar ``` |\n@| username | string | 是 | - | - | Gets and sets the username portion of the URL. ```js const myURL = new URL('https://abc:xyz@example.com'); console.log(myURL.username); // Prints abc myURL.username = '123'; console.log(myURL.href); // Prints https://123:xyz@example.com/ ``` Any invalid URL characters appearing in the value assigned the `username`property will be `percent-encoded`. The selection of which characters to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce. | \n\n##### URLSearchParams 的方法 @urlsearchparams-values \n\n##### append(name, value) @append\n\nAppend a new name-value pair to the query string.\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - |\n| value | string | 是 | - | - | - | \n\n\n###### append 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### delete(name) @delete\n\nRemove all name-value pairs whose name is `name`.\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - | \n\n\n###### delete 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### entries() @entries\n\nReturns an ES6 `Iterator` over each of the name-value pairs in the query.\nEach item of the iterator is a JavaScript `Array`. The first item of the `Array`is the `name`, the second item of the `Array` is the `value`.\n\nAlias for `urlSearchParams[@@iterator]()`.\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| IterableIterator\\<\\[string, string\\] |\n \n\n###### entries 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### forEach(callback, thisArg?) @foreach\n\nIterates over each name-value pair in the query and invokes the given function.\n\n```js\nconst myURL = new URL('https://example.org/?a=b&c=d');\nmyURL.searchParams.forEach((value, name, searchParams) => {\n console.log(name, value, myURL.searchParams === searchParams);\n});\n// Prints:\n// a b true\n// c d true\n```\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (this: any, value: string, name: string, searchParams: [URLSearchParams](#urlsearchparams-values)) => void | 是 | - | - | Invoked for each name-value pair in the query |\n| thisArg | any | 否 | - | - | To be used as `this` value for when `fn` is called | \n\n\n###### forEach 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### get(name) @get\n\nReturns the value of the first name-value pair whose name is `name`. If there\nare no such pairs, `null` is returned.\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| string \\| null | 否 |\n \n\n###### get 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### getAll(name) @getall\n\nReturns the values of all name-value pairs whose name is `name`. If there are\nno such pairs, an empty array is returned.\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Array\\ |\n \n\n###### getAll 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### has(name) @has\n\nReturns `true` if there is at least one name-value pair whose name is `name`.\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n###### has 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### keys() @keys\n\nReturns an ES6 `Iterator` over the names of each name-value pair.\n\n```js\nconst params = new URLSearchParams('foo=bar&foo=baz');\nfor (const name of params.keys()) {\n console.log(name);\n}\n// Prints:\n// foo\n// foo\n```\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| IterableIterator\\ |\n \n\n###### keys 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### set(name, value) @set\n\nSets the value in the `URLSearchParams` object associated with `name` to`value`. If there are any pre-existing name-value pairs whose names are `name`,\nset the first such pair's value to `value` and remove all others. If not,\nappend the name-value pair to the query string.\n\n```js\nconst params = new URLSearchParams();\nparams.append('foo', 'bar');\nparams.append('foo', 'baz');\nparams.append('abc', 'def');\nconsole.log(params.toString());\n// Prints foo=bar&foo=baz&abc=def\n\nparams.set('foo', 'def');\nparams.set('xyz', 'opq');\nconsole.log(params.toString());\n// Prints foo=def&abc=def&xyz=opq\n```\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - |\n| value | string | 是 | - | - | - | \n\n\n###### set 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### sort() @sort\n\nSort all existing name-value pairs in-place by their names. Sorting is done\nwith a \\[stable sorting algorithm](https://en.wikipedia.org/wiki/Sorting_algorithm#Stability), so relative order between name-value pairs\nwith the same name is preserved.\n\nThis method can be used, in particular, to increase cache hits.\n\n```js\nconst params = new URLSearchParams('query[]=abc&type=search&query[]123');\nparams.sort();\nconsole.log(params.toString());\n// Prints query%5B%5D=abc&query%5B%5D=123&type=search\n```\n\n\n###### sort 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### toString() @tostring\n\nReturns the search parameters serialized as a string, with characters\npercent-encoded where necessary.\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| string |\n \n\n###### toString 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### values() @values\n\nReturns an ES6 `Iterator` over the values of each name-value pair.\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| IterableIterator\\ |\n \n\n###### values 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### URL 的方法 @url-values \n\n##### toString() @tostring\n\nThe `toString()` method on the `URL` object returns the serialized URL. The\nvalue returned is equivalent to that of {@link href} and {@link toJSON}.\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| string |\n \n\n###### toString 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### toJSON() @tojson\n\nThe `toJSON()` method on the `URL` object returns the serialized URL. The\nvalue returned is equivalent to that of {@link href} and {@link toString}.\n\nThis method is automatically called when an `URL` object is serialized\nwith \\[`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify).\n\n```js\nconst myURLs = [\n new URL('https://www.example.com'),\n new URL('https://test.example.org'),\n];\nconsole.log(JSON.stringify(myURLs));\n// Prints [\"https://www.example.com/\",\"https://test.example.org/\"]```\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| string |\n \n\n###### toJSON 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果成功处理请求，则为true;如果尝试打开URL资源失败，则为false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationOpenURLOptions":{"name":"### applicationOpenURLOptions(app?, url?, options?)","description":"\n通过 url scheme 方式唤起 app 时的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| app | UIApplication | 是 | - | - | - |\n| url | [URL](#url-values) | 是 | - | - | 要打开的URL资源。该资源可以是网络资源或文件。 |\n| options | Map\\ | 是 | - | - | URL处理选项的字典, 默认值为 null 。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果成功处理请求，则为true;如果尝试打开URL资源失败，则为false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationWillResignActive":{"name":"### applicationWillResignActive(application?)","description":"\n当应用从活动状态主动变为非活动状态的时的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| application | UIApplication | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationDidBecomeActive":{"name":"### applicationDidBecomeActive(application?)","description":"\n应用完全激活时的回调函数。\n应用程序冷启动或者从后台转到前台后都会完全激活应用程序。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| application | UIApplication | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationDidEnterBackground":{"name":"### applicationDidEnterBackground(application?)","description":"\n应用程序进入后台时的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| application | UIApplication | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationWillEnterForeground":{"name":"### applicationWillEnterForeground(application?)","description":"\n当应用在后台状态，将要进入到前台运行时的回调函数。\n应用程序冷启动时不会回调此方法。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| application | UIApplication | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationMain":{"name":"### applicationMain(argc, argv)","description":"\n应用程序的 main 函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| argc | Int32 | 是 | - | - | - |\n| argv | UnsafeMutablePointer\\ \\| null> | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationContinueUserActivityRestorationHandler":{"name":"### applicationContinueUserActivityRestorationHandler(application?, userActivity?, restorationHandler?)","description":"\n当应用程序接收到与用户活动相关的数据时调用此方法，例如，当用户使用 Universal Link 唤起应用时。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| application | UIApplication | 是 | - | - | App 的 UIApplicationDelegate 对象。 |\n| userActivity | NSUserActivity | 是 | - | - | 包含与用户正在执行的任务相关联的数据的活动对象。使用这些数据来继续用户在iOS应用中的活动。 |\n| restorationHandler | ((res ?: \\\\[any]=> void) | 是 | - | - | 需要执行的回调，该回调是可选的，默认值为 null。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | true表示你的应用处理了这个活动，false表示让iOS知道你的应用没有处理这个活动。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"}},"UTSAndroidHookProxy":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UTSAndroidHookProxy)","onCreate":{"name":"### onCreate(application)","description":"\nuts 插件创建时的回调。\n对应原生 Application onCreate 函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| application | Application | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.97 | x | - | x | x | - |\n","itemType":"method"}},"UniActivityCallback":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UniActivityCallback)","onAttachFragment":{"name":"### onAttachFragment(params, fragment)","description":"\n对应原生 Activity 的 [onAttachFragment](https://developer.android.com/reference/android/app/Activity#onAttachFragment(android.app.Fragment)) 函数，此方法在 Fragment 被附加到 Activity 时被调用，以处理相关联的逻辑。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 fragment 表示被附加的 Fragment 实例。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| fragment | Fragment | 是 | - | - | 被附加的 Fragment 实例 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onUserInteraction":{"name":"### onUserInteraction(params)","description":"\n对应原生 Activity 的 [onUserInteraction](https://developer.android.com/reference/android/app/Activity#onUserInteraction()) 函数，该方法在用户与设备进行交互时被调用，用于处理用户交互前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onUserLeaveHint":{"name":"### onUserLeaveHint(params)","description":"\n对应原生 Activity 的 [onUserLeaveHint](https://developer.android.com/reference/android/app/Activity#onUserLeaveHint()) 函数，此方法在用户即将离开应用且返回到上一级活动（通过按Home键等操作造成的）时被调用，用于处理用户即将离开应用前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onActivityResult":{"name":"### onActivityResult(params, requestCode, resultCode, data)","description":"\n对应原生 Activity 的 [onActivityResult](https://developer.android.com/reference/android/app/Activity#onActivityResult(int,%20int,%20android.content.Intent)) 函数，此方法在从另一个活动返回数据时被调用，用于处理返回数据前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams，第二和第三个参数分别代表请求代码和结果代码，第四个参数 data 为返回的数据。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| requestCode | Int | 是 | - | - | 请求代码 |\n| resultCode | Int | 是 | - | - | 结果代码 |\n| data | Intent \\| null | 否 | - | - | 返回的数据 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onRequestPermissionsResult":{"name":"### onRequestPermissionsResult(params, requestCode, permissions, grantResults)","description":"\n对应原生 Activity 的 \\[onRequestPermissionsResult](https://developer.android.com/reference/android/app/Activity#onRequestPermissionsResult(int,%20java.lang.String[],%20int[]) 函数，此方法在用户响应权限请求后被调用，用于处理权限请求结果前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 requestCode 为请求代码，第三个参数 permissions 为请求的权限数组，第四个参数 grantResults 为权限请求结果数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| requestCode | Int | 是 | - | - | 请求代码 |\n| permissions | MutableList\\ | 是 | - | - | 请求的权限 |\n| grantResults | IntArray | 是 | - | - | 权限请求结果 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onApplyThemeResource":{"name":"### onApplyThemeResource(params, theme, resid, first)","description":"\n对应原生 Activity 的 [onApplyThemeResource](https://developer.android.com/reference/android/app/Activity#onApplyThemeResource(android.content.res.Resources.Theme,%20int,%20boolean)) 函数，此方法在应用主题资源时被调用，用于处理主题资源应用前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 theme 为要应用的主题资源，第三个参数 resid 为资源ID，第四个参数 first 标示是否为首次应用。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| theme | Resources.Theme | 是 | - | - | 要应用的主题资源 |\n| resid | Int | 是 | - | - | 资源ID |\n| first | Boolean | 是 | - | - | 是否为首次应用 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onCreateView":{"name":"### onCreateView(params, parent, name, context, attrs)","description":"\n对应原生 Activity 的 [onCreateView](https://developer.android.com/reference/android/app/Activity#onCreateView(android.view.View,%20java.lang.String,%20android.content.Context,%20android.util.AttributeSet))函数，此方法在视图创建时被调用，用于处理视图创建前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams，后续参数分别为 parent 视图的父视图，name 视图名称，context 视图的上下文环境及 attrs 视图的属性集。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| parent | View \\| null | 否 | - | - | 父视图 |\n| name | string | 是 | - | - | 视图名称 |\n| context | Context | 是 | - | - | 上下文环境 |\n| attrs | AttributeSet | 是 | - | - | 属性集 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onTitleChanged":{"name":"### onTitleChanged(params, title, color)","description":"\n对应原生 Activity [onTitleChanged](https://developer.android.com/reference/android/app/Activity#onTitleChanged(java.lang.CharSequence,%20int)) 函数，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| title | string | 是 | - | - | 新的标题字符 |\n| color | Int | 是 | - | - | 新的标题颜色 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onChildTitleChanged":{"name":"### onChildTitleChanged(params, childActivity, title)","description":"\n对应原生 Activity [onChildTitleChanged](https://developer.android.com/reference/android/app/Activity#onChildTitleChanged(android.app.Activity,%20java.lang.CharSequence)) 函数，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| childActivity | Activity | 是 | - | - | 子Activity的实例 |\n| title | string | 是 | - | - | 新的子Activity标题字符 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onBackPressed":{"name":"### onBackPressed(params)","description":"\n对应原生 Activity [onBackPressed](https://developer.android.com/reference/android/app/Activity#onBackPressed()) 函数，注意第一个参数为自定义参数 UniActivityParams。\n当用户尝试回退当前页面时调用，可用于自定义回退行为或拦截回退事件。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onContextMenuClosed":{"name":"### onContextMenuClosed(params, menu)","description":"\n对应原生 Activity [onContextMenuClosed](https://developer.android.com/reference/android/app/Activity#onContextMenuClosed(android.view.Menu)) 函数，注意第一个参数为自定义参数 UniActivityParams。\n当上下文菜单被关闭时调用，可用于执行菜单关闭后的操作。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| menu | Menu | 是 | - | - | 关闭的菜单 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onCreateContextMenu":{"name":"### onCreateContextMenu(params, menu, v, menuInfo)","description":"\n对应原生 Activity [onCreateContextMenu](https://developer.android.com/reference/android/app/Activity#onCreateContextMenu(android.view.ContextMenu,%20android.view.View,%20android.view.ContextMenu.ContextMenuInfo)) 函数，注意第一个参数为自定义参数 UniActivityParams。\n当创建上下文菜单时调用，可用于定制上下文菜单的内容。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| menu | ContextMenu | 是 | - | - | 要创建的上下文菜单 |\n| v | View | 是 | - | - | 与上下文菜单相关联的视图 |\n| menuInfo | ContextMenu.ContextMenuInfo \\| null | 否 | - | - | 关联上下文菜单的附加信息，可为空 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onOptionsMenuClosed":{"name":"### onOptionsMenuClosed(params, menu)","description":"\n对应原生 Activity [onOptionsMenuClosed](https://developer.android.com/reference/android/app/Activity#onOptionsMenuClosed(android.view.Menu)) 函数，注意第一个参数为自定义参数 UniActivityParams。\n当选项菜单被关闭时调用。可用于执行菜单关闭后的操作。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| menu | Menu | 是 | - | - | 关闭的菜单 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPrepareNavigateUpTaskStack":{"name":"### onPrepareNavigateUpTaskStack(params, builder)","description":"\n对应原生 Activity [onPrepareNavigateUpTaskStack](https://developer.android.com/reference/android/app/Activity#onPrepareNavigateUpTaskStack(android.app.TaskStackBuilder)) 函数，注意第一个参数为自定义参数 UniActivityParams。\n此方法在用户从当前 Activity 导航到应用的祖先 Activity 时调用，以准备返回栈。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| builder | TaskStackBuilder | 是 | - | - | 返回栈建造者，用于构造导航返回栈 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onProvideAssistData":{"name":"### onProvideAssistData(params, data)","description":"\n对应原生 Activity [onProvideAssistData](https://developer.android.com/reference/android/app/Activity#onProvideAssistData(android.os.Bundle)) 函数，注意第一个参数为自定义参数 UniActivityParams。\n此方法在构建辅助数据时被调用，比如在使用 Google Now 时展示有关当前 Activity 的信息。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| data | Bundle | 是 | - | - | 提供辅助数据的 Bundle | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onProvideAssistContent":{"name":"### onProvideAssistContent(params, outContent)","description":"\n对应原生 Activity [onProvideAssistContent](https://developer.android.com/reference/android/app/Activity#onProvideAssistContent(android.app.assist.AssistContent)) 函数，注意第一个参数为自定义参数 UniActivityParams。\n此方法允许Activity提供有关其当前在屏幕上显示的内容的附加信息，这有助于提升语音搜索等辅助功能的体验。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| outContent | AssistContent | 是 | - | - | 通过这个参数，Activity可以提供有关其内容的结构化信息。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreAttachFragment":{"name":"### onPreAttachFragment(params, fragment)","description":"\n对应原生 Activity [onAttachFragment](https://developer.android.com/reference/android/app/Activity#onAttachFragment(android.app.Fragment)) 函数，该方法在Fragment与Activity建立关联时调用。本方法的调用时机在super.onAttachFragment()之前，它允许您在Fragment完全附加到Activity之前进行必要的设置或初始化。\n提在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| fragment | Fragment | 是 | - | - | 即将附加的Fragment对象。这允许Activity在Fragment完全附加之前与之交互。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreUserInteraction":{"name":"### onPreUserInteraction(params)","description":"\n对应原生 Activity [onUserInteraction](https://developer.android.com/reference/android/app/Activity#onUserInteraction()) 函数。\n在用户与设备进行交互时被调用，例如触摸屏幕或按键。开发者可以覆盖此方法以执行特定操作，如取消自动隐藏的导航控件等。\n在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreUserLeaveHint":{"name":"### onPreUserLeaveHint(params)","description":"\n对应原生 Activity [onUserLeaveHint](https://developer.android.com/reference/android/app/Activity#onUserLeaveHint()) 函数。\n当用户即将离开当前Activity时被调用，通常是因为用户按了 \"Home\" 键或最近任务键。可以覆盖此方法来实现特定的暂停、保存状态或资源释放操作。\n在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreActivityResult":{"name":"### onPreActivityResult(params, requestCode, resultCode, data)","description":"\n对应原生 Activity [onActivityResult](https://developer.android.com/reference/android/app/Activity#onActivityResult(int,%20int,%20android.content.Intent)) 函数。\n当一个启动的Activity返回结果时调用。在super方法之前调用。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| requestCode | Int | 是 | - | - | 请求代码，标识发送请求的Activity |\n| resultCode | Int | 是 | - | - | 结果代码，表明操作是否成功或取消 |\n| data | Intent \\| null | 否 | - | - | 含返回数据的Intent对象或null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreApplyThemeResource":{"name":"### onPreApplyThemeResource(params, theme, resid, first)","description":"\n对应原生 Activity [onApplyThemeResource](https://developer.android.com/reference/android/app/Activity#onApplyThemeResource(android.content.res.Resources.Theme,int,boolean)) 函数。\n在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| theme | Resources.Theme | 是 | - | - | 当前 Activity 即将应用的主题资源 |\n| resid | Int | 是 | - | - | 用于应用主题的资源ID |\n| first | Boolean | 是 | - | - | 是否为第一次应用该主题 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreCreateView":{"name":"### onPreCreateView(params, parent, name, context, attrs)","description":"\n对应原生 Activity [onCreateView](https://developer.android.com/reference/android/app/Activity#onCreateView(android.view.View,java.lang.String,android.content.Context,android.util.AttributeSet)) 函数。\n在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| parent | View \\| null | 否 | - | - | 即将创建视图的父视图 |\n| name | [String](#string-values) | 是 | - | - | 视图的标识名 |\n| context | Context | 是 | - | - | 视图创建时的上下文 |\n| attrs | AttributeSet | 是 | - | - | 视图的属性集 | \n\n##### String 的方法 @string-values \n\n##### at(index) @at\n\nTakes an integer value and returns the item at that index,\nallowing for positive and negative integers.\nNegative integers count back from the last item in the array.\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| index | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| T \\| any |\n \n\n###### at 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreTitleChanged":{"name":"### onPreTitleChanged(params, title, color)","description":"\n对应原生 Activity [onTitleChanged](https://developer.android.com/reference/android/app/Activity#onTitleChanged(java.lang.CharSequence,%20int)) 函数，\n在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| title | [String](#string-values) | 是 | - | - | 即将设置的新标题。 |\n| color | Int | 是 | - | - | 标题的颜色。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreChildTitleChanged":{"name":"### onPreChildTitleChanged(params, childActivity, title)","description":"\n对应原生 Activity [onChildTitleChanged](https://developer.android.com/reference/android/app/Activity#onChildTitleChanged(android.app.Activity,%20java.lang.CharSequence)) 函数，\n在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| childActivity | Activity | 是 | - | - | 标题变更的子Activity。 |\n| title | [String](#string-values) | 是 | - | - | 即将设置的新标题。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreBackPressed":{"name":"### onPreBackPressed(params)","description":"\n对应原生 Activity [onBackPressed](https://developer.android.com/reference/android/app/Activity#onBackPressed()) 函数，\n在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreContextMenuClosed":{"name":"### onPreContextMenuClosed(params, menu)","description":"\n对应原生 Activity [onContextMenuClosed](https://developer.android.com/reference/android/app/Activity#onContextMenuClosed(android.view.Menu)) 函数，\n在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| menu | Menu | 是 | - | - | 引发上下文菜单关闭事件的菜单。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreCreateContextMenu":{"name":"### onPreCreateContextMenu(params, menu, v, menuInfo)","description":"\n对应原生 Activity [onCreateContextMenu](https://developer.android.com/reference/android/app/Activity#onCreateContextMenu(android.view.ContextMenu,%20android.view.View,%20android.view.ContextMenu.ContextMenuInfo)) 函数，\n在 super 方法之前调用，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| menu | ContextMenu | 是 | - | - | 要创建的上下文菜单。 |\n| v | View | 是 | - | - | 引发上下文菜单的视图。 |\n| menuInfo | ContextMenu.ContextMenuInfo \\| null | 否 | - | - | 与上下文菜单关联的上下文菜单信息，如果没有则为 null。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreOptionsMenuClosed":{"name":"### onPreOptionsMenuClosed(params, menu)","description":"\n对应原生 Activity [onOptionsMenuClosed](https://developer.android.com/reference/android/app/Activity#onOptionsMenuClosed(android.view.Menu)) 函数，\n在 super 方法之前调用，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| menu | Menu | 是 | - | - | 被关闭的选项菜单。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPrePrepareNavigateUpTaskStack":{"name":"### onPrePrepareNavigateUpTaskStack(params, builder)","description":"\n对应原生 Activity [onPrepareNavigateUpTaskStack](https://developer.android.com/reference/android/app/Activity#onPrepareNavigateUpTaskStack(android.app.TaskStackBuilder)) 函数，\n在 super 方法之前调用，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| builder | TaskStackBuilder | 是 | - | - | 用于构建向上导航任务栈的 TaskStackBuilder 实例。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreProvideAssistData":{"name":"### onPreProvideAssistData(params, data)","description":"\n对应原生 Activity [onProvideAssistData](https://developer.android.com/reference/android/app/Activity#onProvideAssistData(android.os.Bundle)) 函数，\n在 super 方法之前调用，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| data | Bundle | 是 | - | - | 辅助数据的捆绑包。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreProvideAssistContent":{"name":"### onPreProvideAssistContent(params, outContent)","description":"\n对应原生 Activity [onProvideAssistContent](https://developer.android.com/reference/android/app/Activity#onProvideAssistContent(android.app.assist.AssistContent)) 函数，\n在 super 方法之前调用，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| outContent | AssistContent | 是 | - | - | 辅助内容的对象。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"}},"UniActivityComponentCallback":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UniActivityComponentCallback)","onConfigurationChanged":{"name":"### onConfigurationChanged(params, newConfig)","description":"\n对应原生 Activity [onConfigurationChanged](https://developer.android.com/reference/android/app/Activity#onConfigurationChanged(android.content.res.Configuration)) 函数，\n当设备配置（如屏幕大小、方向、语言等）发生改变时调用。开发者可以通过重写此方法来处理配置更改事件。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这允许开发者在处理配置更改时访问特定的环境信息。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| newConfig | Configuration | 是 | - | - | 新的设备配置数据。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onLowMemory":{"name":"### onLowMemory(params)","description":"\n对应原生 Activity [onLowMemory](https://developer.android.com/reference/android/app/Activity#onLowMemory()) 函数，\n当系统运行在低内存环境下时调用。在这种情况下，开发者应当清除不必要的资源以帮助系统回收内存，减轻内存压力。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这提供了一个机会，让开发者能够在应用面临低内存情况时执行特定逻辑。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onTrimMemory":{"name":"### onTrimMemory(params, level)","description":"\n对应原生 Activity [onTrimMemory](https://developer.android.com/reference/android/app/Activity#onTrimMemory(int)) 函数，\n当系统决定当前进程需要缩减内存使用时调用。开发者可以根据传递的内存级别清除不必要的资源以帮助系统管理内存。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这使得开发者能够基于应用的当前状态适当地响应内存清理需求。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| level | Int | 是 | - | - | 提供了当前内存清理级别的指示，开发者可以根据这个级别确定清理资源的紧迫性。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreConfigurationChanged":{"name":"### onPreConfigurationChanged(params, newConfig)","description":"\n该方法是对原生 Activity [onConfigurationChanged](https://developer.android.com/reference/android/app/Activity#onConfigurationChanged(android.content.res.Configuration)) 函数的扩展，\n在 super 方法之前调用，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这为开发者提供了一个机会，让他们能够在配置更改生效之前对其进行预处理。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| newConfig | Configuration | 是 | - | - | 提供了新的设备配置信息，允许开发者根据这些信息调整应用行为。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreLowMemory":{"name":"### onPreLowMemory(params)","description":"\n此方法在 Activity 的 [onLowMemory](https://developer.android.com/reference/android/app/Activity#onLowMemory()) 方法被触发之前调用，\n允许开发者在系统通知内存不足之前执行自定义逻辑。这可以用于积极地释放资源或减少内存使用，以避免应用被系统杀死。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。它们可以被用来做出更加上下文相关的响应。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreTrimMemory":{"name":"### onPreTrimMemory(params, level)","description":"\n此方法在 Activity 的 [onTrimMemory](https://developer.android.com/reference/android/app/Activity#onTrimMemory(int)) 方法被触发之前调用，\n允许开发者在系统建议应用减少内存使用之前预先采取措施。这里的处理可以根据传递的内存级别清除缓存或其他不必要的资源。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。使用这些信息，可以选择性地进行内存优化。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| level | Int | 是 | - | - | 系统传递的当前内存清理级别的枚举值。开发者可以基于这个级别来调整他们的内存管理策略。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"}},"UniActivityKeyEventCallback":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UniActivityKeyEventCallback)","onKeyDown":{"name":"### onKeyDown(params, keyCode, event)","description":"\n此方法对应 Android Activity 的 [onKeyDown](https://developer.android.com/reference/android/app/Activity#onKeyDown(int,%20android.view.KeyEvent)) 函数，\n在用户按下键盘键（例如返回键、菜单键等）时调用。可以用于自定义按键事件的响应逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这些参数为开发者提供了当前活动上下文以及任何先前操作的结果。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| keyCode | Int | 是 | - | - | 表明被按下的键的键码。 |\n| event | KeyEvent \\| null | 否 | - | - | 提供了关于按键事件的详细信息，包括按键的动作和代码。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onKeyLongPress":{"name":"### onKeyLongPress(params, keyCode, event)","description":"\n此方法对应 Android Activity 的 [onKeyLongPress](https://developer.android.com/reference/android/app/Activity#onKeyLongPress(int,%20android.view.KeyEvent)) 函数，\n在用户长按键盘键时调用。这通常用于执行按键的二级功能。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这样，开发者可以利用设置的返回参数执行上下文相关的操作。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| keyCode | Int | 是 | - | - | 表明长按的键的键码。 |\n| event | KeyEvent \\| null | 否 | - | - | 提供关于长按键事件的额外信息，允许开发者根据需要来响应事件。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onKeyUp":{"name":"### onKeyUp(params, keyCode, event)","description":"\n此方法对应 Android Activity 的 [onKeyUp](https://developer.android.com/reference/android/app/Activity#onKeyUp(int,%20android.view.KeyEvent)) 函数，\n在用户松开键盘键时调用。可以用于处理按键抬起事件。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这些参数为开发者提供当前上下文及函数调用的相关结果。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| keyCode | Int | 是 | - | - | 表示松开的键的键码。 |\n| event | KeyEvent \\| null | 否 | - | - | 提供了关于按键事件的详细信息，包含按键的动作和代码等。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onKeyMultiple":{"name":"### onKeyMultiple(params, keyCode, repeatCount, event)","description":"\n此方法对应 Android Activity 的 [onKeyMultiple](https://developer.android.com/reference/android/app/Activity#onKeyMultiple(int,%20int,%20android.view.KeyEvent)) 函数，\n在用户进行多个按键事件时调用（例如，当用户按住某个键时会连续触发此事件）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。可以用来执行基于当前应用状态的操作。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| keyCode | Int | 是 | - | - | 表示重复按下的键的键码。 |\n| repeatCount | Int | 是 | - | - | 表明此键的重复次数。 |\n| event | KeyEvent \\| null | 否 | - | - | 提供按键事件的详细信息。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreKeyDown":{"name":"### onPreKeyDown(params, keyCode, event)","description":"\n在 Android Activity 的 [onKeyDown](https://developer.android.com/reference/android/app/Activity#onKeyDown(int,%20android.view.KeyEvent)) 方法触发之前调用，\n允许开发者在标准按键处理流程之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。便于开发者获取上下文信息和返回的数据。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| keyCode | Int | 是 | - | - | 按下的键的键码。 |\n| event | KeyEvent \\| null | 否 | - | - | 提供按键事件的详细信息。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreKeyLongPress":{"name":"### onPreKeyLongPress(params, keyCode, event)","description":"\n在 Android Activity 的 [onKeyLongPress](https://developer.android.com/reference/android/app/Activity#onKeyLongPress(int,%20android.view.KeyEvent)) 方法触发之前调用，\n允许开发者在标准长按处理流程之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。开发者可以利用这些返回值进行进一步处理。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| keyCode | Int | 是 | - | - | 长按的键的键码。 |\n| event | KeyEvent \\| null | 否 | - | - | 提供长按键事件的详细信息。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreKeyUp":{"name":"### onPreKeyUp(params, keyCode, event)","description":"\n在 Android Activity 的 [onKeyUp](https://developer.android.com/reference/android/app/Activity#onKeyUp(int,%20android.view.KeyEvent)) 方法触发之前调用，\n允许开发者在标准按键抬起处理流程之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。便于开发者获取和处理返回的数据。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| keyCode | Int | 是 | - | - | 松开的键的键码。 |\n| event | KeyEvent \\| null | 否 | - | - | 提供按键抬起事件的详细信息。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreKeyMultiple":{"name":"### onPreKeyMultiple(params, keyCode, repeatCount, event)","description":"\n在 Android Activity 的 [onKeyMultiple](https://developer.android.com/reference/android/app/Activity#onKeyMultiple(int,%20int,%20android.view.KeyEvent)) 方法触发之前调用，\n允许开发者在处理多个按键事件之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。开发者可以根据这些返回值对按键事件进行处理。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| keyCode | Int | 是 | - | - | 表示触发多次的键的键码。 |\n| repeatCount | Int | 是 | - | - | 按键重复的次数。 |\n| event | KeyEvent \\| null | 否 | - | - | 提供多个按键事件的详细信息。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"}},"UniActivityLifeCycleCallback":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UniActivityLifeCycleCallback)","onCreate":{"name":"### onCreate(params, savedInstanceState)","description":"\n此方法对应 Android Activity 的 [onCreate](https://developer.android.com/reference/android/app/Activity#onCreate(android.os.Bundle)) 函数，\n当Activity正在被创建时调用。这个回调提供了一种方法来执行任何初始化——创建视图、绑定数据等操作。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值，这些参数为开发者提供了当前上下文及函数调用的相关结果。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| savedInstanceState | Bundle \\| null | 否 | - | - | 如果Activity在之前被销毁，现在正在重新创建，这个Bundle将包含上次保存的状态数据。如果Activity是首次创建，则为null。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreCreate":{"name":"### onPreCreate(params, savedInstanceState)","description":"\n在 Android Activity 的 [onCreate](https://developer.android.com/reference/android/app/Activity#onCreate(android.os.Bundle)) 方法触发之前调用，\n允许开发者在 Activity 创建之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这些参数为开发者提供了当前的上下文信息和方法调用的结果。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| savedInstanceState | Bundle \\| null | 否 | - | - | 如果 Activity 正在重新创建，则此参数包含之前保存的状态信息。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onStart":{"name":"### onStart(params)","description":"\n对应原生 Activity 的 [onStart](https://developer.android.com/reference/android/app/Activity#onStart()) 函数，当Activity即将对用户可见时调用。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreStart":{"name":"### onPreStart(params)","description":"\n在 Android Activity 的 [onStart](https://developer.android.com/reference/android/app/Activity#onStart()) 方法触发之前调用，\n允许开发者在 Activity 开始之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这些参数为开发者提供了进行操作所需的上下文信息。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onRestart":{"name":"### onRestart(params)","description":"\n对应原生 Activity 的 [onRestart](https://developer.android.com/reference/android/app/Activity#onRestart()) 函数，当Activity在停止后重新启动前调用。\n注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreRestart":{"name":"### onPreRestart(params)","description":"\n对应原生 Activity 的 [onRestart](https://developer.android.com/reference/android/app/Activity#onRestart()) 函数，在super方法之前调用。此为在 Activity 重启前额外的准备步骤，提供了自定义操作的机会。\n在 super 方法之前调用，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onResume":{"name":"### onResume(params)","description":"\n对应原生 Activity 的 [onResume](https://developer.android.com/reference/android/app/Activity#onResume()) 函数，在 Activity 准备和用户进行交互时调用。此时 Activity 处于运行状态的顶层。\n注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreResume":{"name":"### onPreResume(params)","description":"\n在 Android Activity 的 [onResume](https://developer.android.com/reference/android/app/Activity#onResume()) 方法触发之前调用，\n允许开发者在 Activity 恢复之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。借助这些参数，开发者可以对 Activity 的恢复行为进行定制。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPause":{"name":"### onPause(params)","description":"\n对应原生 Activity 的 [onPause](https://developer.android.com/reference/android/app/Activity#onPause()) 函数，当 Activity 开始进入不活动状态（即用户即将离开此 Activity）时调用。此时应当暂停正在进行的操作和更新 UI 数据。\n注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPrePause":{"name":"### onPrePause(params)","description":"\n在 Android Activity 的 [onPause](https://developer.android.com/reference/android/app/Activity#onPause()) 方法触发之前调用，\n允许开发者在 Activity 暂停之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这些参数提供了进行必要操作所需的上下文。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onStop":{"name":"### onStop(params)","description":"\n对应原生 Activity 的 [onStop](https://developer.android.com/reference/android/app/Activity#onStop()) 函数，在 Activity 即将停止时被调用，这通常是因为 Activity 即将被销毁，或因为用户切换到了另一个 Activity。在此阶段，应保存数据或进行清理工作。\n注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreStop":{"name":"### onPreStop(params)","description":"\n在 Android Activity 的 [onStop](https://developer.android.com/reference/android/app/Activity#onStop()) 方法触发之前调用，\n允许开发者在 Activity 停止之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。利用这些返回参数，开发者可以优化 Activity 的停止过程。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onDestroy":{"name":"### onDestroy(params)","description":"\n在 Android Activity 的 [onDestroy](https://developer.android.com/reference/android/app/Activity#onDestroy()) 方法触发时调用，\n允许开发者在 Activity 销毁之前执行自定义逻辑或清理资源。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这些参数为开发者提供了当前的上下文信息和方法调用的结果。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreDestroy":{"name":"### onPreDestroy(params)","description":"\n在 Android Activity 的 [onDestroy](https://developer.android.com/reference/android/app/Activity#onDestroy()) 方法触发之前调用，\n允许开发者在 Activity 销毁之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这为开发者提供了一个机会，在 Activity 销毁之前做必要的资源释放与保存。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"}},"UniActivityWindowCallback":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UniActivityWindowCallback)","onDetachedFromWindow":{"name":"### onDetachedFromWindow(params)","description":"\n对应原生 Activity 的 [onDetachedFromWindow](https://developer.android.com/reference/android/view/View#onDetachedFromWindow()) 函数，当 Activity 的窗口从窗口管理器中移除时调用。这是进行最后清理的好时机。\n注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onContentChanged":{"name":"### onContentChanged(params)","description":"\n对应原生 Activity 的 [onContentChanged](https://developer.android.com/reference/android/app/Activity#onContentChanged()) 函数，当 Activity 的内容视图更改时调用。这可以作为响应内容更改并更新 UI 的适当时机。\n注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onWindowAttributesChanged":{"name":"### onWindowAttributesChanged(params, attrs)","description":"\n对应原生 Activity 的 [onWindowAttributesChanged](https://developer.android.com/reference/android/view/Window.Callback#onWindowAttributesChanged(android.view.WindowManager.LayoutParams)) 函数，当当前窗口属性更改时调用，如大小、透明度等。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 attrs 为窗口参数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| attrs | WindowManager.LayoutParams | 是 | - | - | 新的窗口属性 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onWindowFocusChanged":{"name":"### onWindowFocusChanged(params, hasFocus)","description":"\n对应原生 Activity 的 [onWindowFocusChanged](https://developer.android.com/reference/android/app/Activity#onWindowFocusChanged(boolean)) 函数，当 Activity 的窗口焦点发生变化时调用，如获得或失去焦点。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 hasFocus 指示窗口是否获得了焦点。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| hasFocus | Boolean | 是 | - | - | 窗口是否获得了焦点 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onAttachedToWindow":{"name":"### onAttachedToWindow(params)","description":"\n对应原生 Activity 的 [onAttachedToWindow](https://developer.android.com/reference/android/view/View#onAttachedToWindow()) 函数，当 Activity 的窗口被添加到窗口管理器时调用。这标志着 Activity 可以开始与用户交互。\n注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPanelClosed":{"name":"### onPanelClosed(params, featureId, menu)","description":"\n对应原生 Activity 的 [onPanelClosed](https://developer.android.com/reference/android/app/Activity#onPanelClosed(int,%20android.view.Menu)) 函数，当菜单面板被关闭时调用，可以在这里做一些清理工作。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 featureId 为面板编号，第三个参数 menu 为面板的菜单。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| featureId | Int | 是 | - | - | 面板编号 |\n| menu | Menu | 是 | - | - | 面板的菜单 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onSearchRequested":{"name":"### onSearchRequested(params)","description":"\n对应原生 Activity 的 [onSearchRequested](https://developer.android.com/reference/android/app/Activity#onSearchRequested()) 函数，当用户请求搜索操作时调用。您可以在这里启动一个搜索界面。\n注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onWindowStartingActionMode":{"name":"### onWindowStartingActionMode(params, callback)","description":"\n对应原生 Activity 的 [onWindowStartingActionMode](https://developer.android.com/reference/android/app/Activity#onWindowStartingActionMode(android.view.ActionMode.Callback)) 函数，当窗口开始进入操作模式时调用，如选择文本操作。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 callback 为操作模式回调。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| callback | ActionMode.Callback \\| null | 否 | - | - | 操作模式的回调 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onWindowStartingActionMode_1":{"name":"### onWindowStartingActionMode(params, callback, type)","description":"\n对应原生 Activity 的 [onWindowStartingActionMode](https://developer.android.com/reference/android/app/Activity#onWindowStartingActionMode(android.view.ActionMode.Callback,%20int)) 函数，使用特定类型时调用。例如，浮动或类型化的操作模式。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 callback 为操作模式回调，第三个参数 type 为操作模式类型。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| callback | ActionMode.Callback \\| null | 否 | - | - | 操作模式的回调 |\n| type | Int | 是 | - | - | 操作模式的类型 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onActionModeFinished":{"name":"### onActionModeFinished(params, mode)","description":"\n对应原生 Activity 的 [onActionModeFinished](https://developer.android.com/reference/android/app/Activity#onActionModeFinished(android.view.ActionMode)) 函数，当操作模式结束时调用。可以在此处执行清理工作。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 mode 为结束的操作模式。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| mode | ActionMode \\| null | 否 | - | - | 结束的操作模式 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onActionModeStarted":{"name":"### onActionModeStarted(params, mode)","description":"\n对应原生 Activity 的 [onActionModeStarted](https://developer.android.com/reference/android/app/Activity#onActionModeStarted(android.view.ActionMode)) 函数，当操作模式开始时调用。可以在此处进行初始化工作。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 mode 为开始的操作模式。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| mode | ActionMode \\| null | 否 | - | - | 开始的操作模式 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onProvideKeyboardShortcuts":{"name":"### onProvideKeyboardShortcuts(params, data, menu, deviceId)","description":"\n对应原生 Activity 的 [onProvideKeyboardShortcuts](https://developer.android.com/reference/android/app/Activity#onProvideKeyboardShortcuts(java.util.List,%20android.view.Menu,%20int)) 函数，当用户请求显示键盘快捷方式帮助时调用。可以在此处提供快捷方式信息。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 data 为键盘快捷方式群组的列表，第三个参数 menu 为相关联的菜单（如果有），第四个参数 deviceId 为请求快捷方式的设备ID。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| data | MutableList\\ \\| null | 否 | - | - | 键盘快捷方式群组的列表 |\n| menu | Menu \\| null | 否 | - | - | 相关联的菜单 |\n| deviceId | Int | 是 | - | - | 设备ID | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPointerCaptureChanged":{"name":"### onPointerCaptureChanged(params, hasCapture)","description":"\n对应原生 Activity 的 [onPointerCaptureChanged](https://developer.android.com/reference/android/app/Activity#onPointerCaptureChanged(boolean)) 函数，当指针捕获状态更改时调用。可以在此处更新 UI 或状态来响应捕获状态的变化。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 hasCapture 指示是否启用了指针捕获。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| hasCapture | Boolean | 是 | - | - | 是否启用了指针捕获 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreDetachedFromWindow":{"name":"### onPreDetachedFromWindow(params)","description":"\n对应原生 Activity 的 [onDetachedFromWindow](https://developer.android.com/reference/android/view/View#onDetachedFromWindow()) 函数，此方法在super.onDetachedFromWindow() 调用之前被调用，用于处理 Activity 的窗口从窗口管理器中即将移除前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreContentChanged":{"name":"### onPreContentChanged(params)","description":"\n对应原生 Activity 的 [onContentChanged](https://developer.android.com/reference/android/app/Activity#onContentChanged()) 函数，此方法在super.onContentChanged() 调用之前被调用，用于处理 Activity 内容更改前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreWindowAttributesChanged":{"name":"### onPreWindowAttributesChanged(params, attrs)","description":"\n对应原生 Activity 的 [onWindowAttributesChanged](https://developer.android.com/reference/android/view/Window.Callback#onWindowAttributesChanged(android.view.WindowManager.LayoutParams)) 函数，此方法在super.onWindowAttributesChanged() 调用之前被调用，用于处理窗口属性更改前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 attrs 为窗口属性参数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| attrs | WindowManager.LayoutParams | 是 | - | - | 窗口属性 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreWindowFocusChanged":{"name":"### onPreWindowFocusChanged(params, hasFocus)","description":"\n对应原生 Activity 的 [onWindowFocusChanged](https://developer.android.com/reference/android/app/Activity#onWindowFocusChanged(boolean)) 函数，此方法在super.onWindowFocusChanged() 调用之前被调用，用于处理窗口焦点更改前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 hasFocus 表示是否获得焦点。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| hasFocus | Boolean | 是 | - | - | 窗口是否获得焦点 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreAttachedToWindow":{"name":"### onPreAttachedToWindow(params)","description":"\n对应原生 Activity 的 [onAttachedToWindow](https://developer.android.com/reference/android/view/View#onAttachedToWindow()) 函数，此方法在super.onAttachedToWindow() 调用之前被调用，用于处理窗口附加到窗口管理器前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPrePanelClosed":{"name":"### onPrePanelClosed(params, featureId, menu)","description":"\n对应原生 Activity 的 [onPanelClosed](https://developer.android.com/reference/android/app/Activity#onPanelClosed(int,%20android.view.Menu)) 函数，此方法在super.onPanelClosed() 调用之前被调用，用于处理面板关闭前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 featureId 表示面板的特征标识，第三个参数 menu 表示关闭的面板的菜单。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| featureId | Int | 是 | - | - | 面板的特征标识 |\n| menu | Menu | 是 | - | - | 面板的菜单 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreSearchRequested":{"name":"### onPreSearchRequested(params)","description":"\n对应原生 Activity 的 [onSearchRequested](https://developer.android.com/reference/android/app/Activity#onSearchRequested()) 函数，此方法在super.onSearchRequested() 调用之前被调用，用于处理搜索请求前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreWindowStartingActionMode":{"name":"### onPreWindowStartingActionMode(params, callback)","description":"\n对应原生 Activity 的 [onWindowStartingActionMode](https://developer.android.com/reference/android/app/Activity#onWindowStartingActionMode(android.view.ActionMode.Callback)) 函数，此方法在super.onWindowStartingActionMode() 调用之前被调用，用于处理窗口开始操作模式前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 callback 为操作模式的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| callback | ActionMode.Callback \\| null | 否 | - | - | 操作模式的回调函数 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreWindowStartingActionMode_1":{"name":"### onPreWindowStartingActionMode(params, callback)","description":"\n对应原生 Activity 的 [onWindowStartingActionMode](https://developer.android.com/reference/android/app/Activity#onWindowStartingActionMode(android.view.ActionMode.Callback)) 函数，此方法在super.onWindowStartingActionMode() 调用之前被调用，用于处理窗口开始操作模式前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 callback 为操作模式的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| callback | ActionMode.Callback \\| null | 否 | - | - | 操作模式的回调函数 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreWindowStartingActionMode_2":{"name":"### onPreWindowStartingActionMode(params, callback, type)","description":"\n对应原生 Activity 的 [onWindowStartingActionMode](https://developer.android.com/reference/android/app/Activity#onWindowStartingActionMode(android.view.ActionMode.Callback,%20int)) 函数，此方法在super.onWindowStartingActionMode() 调用之前被调用，用于处理特定类型操作模式开始前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 callback 为操作模式的回调函数，第三个参数 type 为操作模式的类型。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| callback | ActionMode.Callback \\| null | 否 | - | - | 操作模式的回调函数 |\n| type | Int | 是 | - | - | 操作模式的类型 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreActionModeFinished":{"name":"### onPreActionModeFinished(params, mode)","description":"\n对应原生 Activity 的 [onActionModeFinished](https://developer.android.com/reference/android/app/Activity#onActionModeFinished(android.view.ActionMode)) 函数，此方法在super.onActionModeFinished() 调用之前被调用，用于处理操作模式结束前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 mode 表示结束的操作模式。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| mode | ActionMode \\| null | 否 | - | - | 结束的操作模式 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreActionModeStarted":{"name":"### onPreActionModeStarted(params, mode)","description":"\n对应原生 Activity 的 [onActionModeStarted](https://developer.android.com/reference/android/app/Activity#onActionModeStarted(android.view.ActionMode)) 函数，此方法在super.onActionModeStarted() 调用之前被调用，用于处理操作模式开始前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 mode 表示开始的操作模式。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| mode | ActionMode \\| null | 否 | - | - | 开始的操作模式 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreProvideKeyboardShortcuts":{"name":"### onPreProvideKeyboardShortcuts(params, data, menu, deviceId)","description":"\n对应原生 Activity 的 [onProvideKeyboardShortcuts](https://developer.android.com/reference/android/app/Activity#onProvideKeyboardShortcuts(java.util.List,%20android.view.Menu,%20int)) 函数，此方法在super.onProvideKeyboardShortcuts() 调用之前被调用，用于处理提供键盘快捷方式前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 data 为键盘快捷键列表，第三个参数 menu 为菜单（如果有），第四个参数 deviceId 为设备ID。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| data | MutableList\\ \\| null | 否 | - | - | 键盘快捷键列表 |\n| menu | Menu \\| null | 否 | - | - | 菜单 |\n| deviceId | Int | 是 | - | - | 设备ID | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPrePointerCaptureChanged":{"name":"### onPrePointerCaptureChanged(params, hasCapture)","description":"\n对应原生 Activity 的 [onPointerCaptureChanged](https://developer.android.com/reference/android/app/Activity#onPointerCaptureChanged(boolean)) 函数，此方法在super.onPointerCaptureChanged() 调用之前被调用，用于处理指针捕获状态改变前的逻辑。\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 hasCapture 表示是否捕获了输入指针。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| hasCapture | Boolean | 是 | - | - | 是否捕获了输入指针 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"dispatchKeyEvent":{"name":"### dispatchKeyEvent(params, event)","description":"\n对应原生 Activity 的 [dispatchKeyEvent](https://developer.android.com/reference/android/app/Activity#dispatchKeyEvent(android.view.KeyEvent)) 函数\n注意第一个参数为自定义参数 UniActivityParams，第二个参数 event 为按键事件。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| event | KeyEvent \\| null | 否 | - | - | 按键事件 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"dispatchPreKeyEvent":{"name":"### dispatchPreKeyEvent(params, event)","description":"\n对应原生 Activity 的 [dispatchKeyEvent](https://developer.android.com/reference/android/app/Activity#dispatchKeyEvent(android.view.KeyEvent)) 函数，此方法在super.dispatchKeyEvent() 调用之前被调用，用于处理按键事件分发前的逻辑。\n在super方法之前调用，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| event | KeyEvent \\| null | 否 | - | - | 按键事件 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"}}} \ No newline at end of file +{"String":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.String)","length":{"name":"### length","description":"返回字符串的 UTF-16 码元长度。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"toString":{"name":"### toString()","description":"返回一个字符串，表示指定的字符串。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | String 包装对象的字符串值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"charAt":{"name":"### charAt(pos)","description":"返回一个由给定索引处的单个 UTF-16 码元构成的新字符串。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| pos | number | 是 | - | - | 要返回的字符的索引，从零开始。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个字符串，该字符串表示指定 index 处的字符（恰好是一个 UTF-16 码元）。如果 index 超出了 0 – str.length - 1 的范围，charAt() 将返回一个空字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"toCharArray":{"name":"### toCharArray()","description":"返回包含此字符串的字符的\\[kotlin.CharArray]","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| CharArray | 字符数组 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | x | √ | x | x |\n","itemType":"method"},"charCodeAt":{"name":"### charCodeAt(index)","description":"返回 0 到 65535 之间的整数，表示给定索引处的 UTF-16 代码单元","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| index | number | 是 | - | - | 一个大于等于 0，小于字符串长度的整数。如果不是一个数值，则默认为 0。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 指定 index 处字符的 UTF-16 代码单元值的一个数字；如果 index 超出范围，charCodeAt() 返回 NaN。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"concat":{"name":"### concat(...strings)","description":"将字符串参数连接到调用的字符串，并返回一个新的字符串。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| strings | string[\\] | 是 | - | - | T要连接到 str 的一个或多个字符串。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个包含所提供的多个字符串文本组合的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"indexOf":{"name":"### indexOf(searchString, position?)","description":"在字符串中搜索指定子字符串，并返回其第一次出现的位置索引。它可以接受一个可选的参数指定搜索的起始位置，如果找到了指定的子字符串，则返回的位置索引大于或等于指定的数字。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchString | string | 是 | - | - | 要搜索的子字符串。 |\n| position | number | 是 | - | - | 该方法返回指定子字符串在大于或等于 position 位置的第一次出现的索引，默认为 0。如果 position 大于调用字符串的长度，则该方法根本不搜索调用字符串。如果 position 小于零，该方法的行为就像 position 为 0 时一样。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 查找的字符串 searchValue 的第一次出现的索引，如果没有找到，则返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"lastIndexOf":{"name":"### lastIndexOf(searchString, position?)","description":"搜索该字符串并返回指定子字符串最后一次出现的索引。它可以接受一个可选的起始位置参数，并返回指定子字符串在小于或等于指定数字的索引中的最后一次出现的位置。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchString | string | 是 | - | - | 要搜索的子字符串。 |\n| position | number | 是 | - | - | 该方法返回指定子字符串在小于或等于 position 的位置中的最后一次出现的索引，默认为 +Infinity。如果 position 大于调用字符串的长度，则该方法将搜索整个字符串。如果 position 小于 0，则行为与 0 相同，即该方法只在索引 0 处查找指定的子字符串。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 如果找到了 searchString，则返回最后一次出现的索引，否则返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"localeCompare":{"name":"### localeCompare(that)","description":"返回一个数字，表示参考字符串在排序顺序中是在给定字符串之前、之后还是与之相同。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| that | string | 是 | - | - | 与 referenceStr 进行比较的字符串。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个数字表示 referenceStr 在排序中是否位于 compareString 的前面、后面或二者相同。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"match":{"name":"### match(regexp)","description":"match() 方法检索字符串与正则表达式进行匹配的结果。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| regexp | string \\| RegExp | 是 | - | - | 一个正则表达式对象或者任何具有 Symbol.match 方法的对象。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| RegExpMatchArray \\| null | 一个 Array，其内容取决于是否存在全局（g）标志，如果没有匹配，则返回 null。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"replace":{"name":"### replace(searchValue, replaceValue)","description":"返回一个由替换值（replacement）替换部分或所有的模式（pattern）匹配项后的新字符串。模式可以是一个字符串或者一个正则表达式。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchValue | string \\| RegExp | 是 | - | - | RegExp: 一个RegExp 对象或者其字面量。该正则所匹配的内容会被第二个参数的返回值替换掉。string: 一个将被 newSubStr 替换的 字符串。其被视为一整个字符串，而不是一个正则表达式。仅第一个匹配项会被替换。 |\n| replaceValue | string | 是 | - | - | 用于替换掉第一个参数在原字符串中的匹配部分的字符串。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个部分或全部匹配由替代模式所取代的新的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"replace_1":{"name":"### replace(searchValue, replacer)","description":"返回一个由替换值（replacement）替换部分或所有的模式（pattern）匹配项后的新字符串。模式可以是一个字符串或者一个正则表达式，替换值是一个每次匹配都要调用的回调函数。如果pattern是字符串，则仅替换第一个匹配项。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchValue | string \\| RegExp | 是 | - | - | RegExp: 一个RegExp 对象或者其字面量。该正则所匹配的内容会被第二个参数的返回值替换掉。string: 一个将被 newSubStr 替换的 字符串。其被视为一整个字符串，而不是一个正则表达式。仅第一个匹配项会被替换。 |\n| replacer | (substring: string, args?: Array\\) => string | 是 | - | - | 一个用来创建新子字符串的函数，该函数的返回值将替换掉第一个参数匹配到的结果。在iOS中replacer的第二个参数是字符串数组而非可变参数。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个部分或全部匹配由替代模式所取代的新的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"search":{"name":"### search(regexp)","description":"search() 方法执行正则表达式和 String 对象之间的一个搜索匹配。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| regexp | string \\| RegExp | 是 | - | - | 一个正则表达式（regular expression）对象。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 如果匹配成功，则 search() 返回正则表达式在字符串中首次匹配项的索引;否则，返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"slice":{"name":"### slice(start?, end?)","description":"slice() 方法提取某个字符串的一部分，并返回一个新的字符串，且不会改动原字符串。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| start | number | 是 | - | - | 可选。从该索引（以 0 为基数）处开始提取原字符串中的字符。如果值为负数，会被当做 strLength + beginIndex 看待，这里的strLength 是字符串的长度（例如，如果 beginIndex 是 -3 则看作是：strLength - 3） |\n| end | number | 是 | - | - | 可选。在该索引（以 0 为基数）处结束提取字符串。如果省略该参数，slice() 会一直提取到字符串末尾。如果该参数为负数，则被看作是 strLength + endIndex，这里的 strLength 就是字符串的长度 (例如，如果 endIndex 是 -3，则是，strLength - 3)。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个从原字符串中提取出来的新字符串 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"split":{"name":"### split(separator, limit?)","description":"split() 方法接受一个模式，通过搜索模式将字符串分割成一个有序的子串列表，将这些子串放入一个数组，并返回该数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| separator | string \\| RegExp | 是 | - | - | 描述每个分割应该发生在哪里的模式。 |\n| limit | number | 是 | - | - | 一个非负整数，指定数组中包含的子字符串的数量限制。当提供此参数时，split 方法会在指定 separator 每次出现时分割该字符串，但在已经有 limit 个元素时停止分割。任何剩余的文本都不会包含在数组中。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string[\\] | 在给定字符串中出现 separator 的每一个点上进行分割而成的字符串数组。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"substring":{"name":"### substring(start, end?)","description":"返回一个字符串在开始索引到结束索引之间的一个子集，或从开始索引直到字符串的末尾的一个子集。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| start | number | 是 | - | - | 要截取的第一个字符的索引，该索引位置的字符作为返回的字符串的首字母。 |\n| end | number | 是 | - | - | 可选。一个 0 到字符串长度之间的整数，以该数字为索引的字符不包含在截取的字符串内。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含给定字符串的指定部分的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"toLowerCase":{"name":"### toLowerCase()","description":"toLowerCase() 会将调用该方法的字符串值转为小写形式，并返回。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个新的字符串，表示转换为小写的调用字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"toLocaleLowerCase":{"name":"### toLocaleLowerCase(locales?)","description":"根据任何指定区域语言环境设置的大小写映射，返回调用字符串被转换为小写的格式。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| locales | string \\| string[\\] | 是 | - | - | 可选。指明要转换成小写格式的特定语言区域。如果以一个数组 Array 形式给出多个 locales, 最合适的地区将被选出来应用。默认的 locale 是主机环境的当前区域 (locale) 设置。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 根据任何特定于语言环境的案例映射规则将被调用字串转换成小写格式的一个新字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"toUpperCase":{"name":"### toUpperCase()","description":"将调用该方法的字符串转为大写形式并返回（如果调用该方法的值不是字符串类型会被强制转换）。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个新的字符串，表示转换为大写的调用字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"toLocaleUpperCase":{"name":"### toLocaleUpperCase(locales?)","description":"根据本地主机语言环境把字符串转换为大写格式，并返回转换后的字符串。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| locales | string \\| string[\\] | 是 | - | - | locales参数指示要用于根据任何特定于语言环境的大小写映射转换为大写的语言环境。如果Array中给出了多个区域设置，则使用最佳可用区域设置。默认语言环境是主机环境的当前语言环境。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 根据任何特定于语言环境的大小写映射，表示转换为大写的调用字符串的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"trim":{"name":"### trim()","description":"从字符串的两端清除空格，返回一个新的字符串，而不修改原始字符串。此上下文中的空格是指所有的空白字符（空格、tab、不换行空格等）以及所有行终止符字符（如 LF、CR 等）。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个表示 str 去掉了开头和结尾的空白字符后的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"substr":{"name":"### substr(from, length?)","description":"返回一个字符串中从指定位置开始到指定字符数的字符。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| from | number | 是 | - | - | 开始提取字符的位置。如果为负值，则被看作 strLength + start，其中 strLength 为字符串的长度（例如，如果 start 为 -3，则被看作 strLength + (-3)）。 |\n| length | number | 是 | - | - | 可选。提取的字符数。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个字符串中从指定位置开始到指定字符数的字符。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"valueOf":{"name":"### valueOf()","description":"返回 String 对象的原始值","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | String 对象的原始值 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"padStart":{"name":"### padStart(targetLength, padString?)","description":"用另一个字符串填充当前字符串（如果需要会重复填充），直到达到给定的长度。填充是从当前字符串的开头开始的。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| targetLength | number | 是 | - | - | 当前 str 填充后的长度。如果该值小于或等于 str.length，则会直接返回当前 str。 |\n| padString | string | 是 | - | - | 可选。用于填充当前 str 的字符串。如果 padString 太长，无法适应 targetLength，则会从末尾被截断。默认值为“ ”字符（U+0020）。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 在开头填充 padString 直到达到给定的 targetLength 所形成的 String。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"padEnd":{"name":"### padEnd(targetLength, padString?)","description":"将当前字符串从末尾开始填充给定的字符串（如果需要会重复填充），直到达到给定的长度。填充是从当前字符串的末尾开始的。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| targetLength | number | 是 | - | - | 当前 str 填充后的长度。如果该值小于或等于 str.length，则会直接返回当前 str。 |\n| padString | string | 是 | - | - | 可选。用于填充当前 str 的字符串。如果 padString 太长，无法适应 targetLength，则会被截断。默认值为“ ”字符（U+0020）。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 在开头填充 padString 直到达到给定的 targetLength 所形成的 String。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"codePointAt":{"name":"### codePointAt(pos)","description":"返回一个小于 1114112 (0x110000) 的非负整数 Number，它是 UTF-16 编码的代码点的代码点值，该代码点始于将此对象转换为字符串而产生的字符串中位置 pos 处的字符串元素。
如果该位置没有元素，则结果未定义。
如果有效的 UTF-16 代理项对不是从 pos 开始，则结果是 pos 处的代码单元。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| pos | number | 是 | - | - | 这个字符串中需要转码的元素的位置。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number \\| null | 返回值是在字符串中的给定索引的编码单元体现的数字，如果在索引处没找到元素则返回 null。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"includes":{"name":"### includes(searchString, position?)","description":"如果 searchString 作为此对象转换为 String 的结果的子字符串出现在大于或等于position的一个或多个位置，则返回 true；否则，返回 false。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchString | string | 是 | - | - | 要在 str 中搜索的字符串。不能是正则表达式。 |\n| position | number | 是 | - | - | 在字符串中开始搜索 searchString 的位置。（默认为 0。） | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果在给定的字符串中找到了要搜索的字符串（包括 searchString 为空字符串的情况），则返回 true，否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"endsWith":{"name":"### endsWith(searchString, endPosition?)","description":"endsWith() 方法用于判断一个字符串是否以指定字符串结尾，如果是则返回 true，否则返回 false。该方法区分大小写。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchString | string | 是 | - | - | 要搜索的作为结尾的字符串，不能是正则表达式。所有非正则表达式的值都会被强制转换为字符串。 |\n| endPosition | number | 是 | - | - | 可选，预期找到 searchString 的末尾位置（即 searchString 最后一个字符的索引加 1）。默认为 str.length。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果被检索字符串的末尾出现了指定的字符串（包括 searchString 为空字符串的情况），则返回 true；否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"normalize":{"name":"### normalize(form)","description":"normalize() 方法会按照指定的一种 Unicode 正规形式将当前字符串规范化。（如果该值不是字符串，则首先将其转换为一个字符串）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| form | \"NFC\" \\| \"NFD\" \\| \"NFKC\" \\| \"NFKD\" | 是 | - | - | 四种 Unicode 正规形式（Unicode Normalization Form）\"NFC\"、\"NFD\"、\"NFKC\"，或 \"NFKD\" 其中的一个，默认值为 \"NFC\"。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 含有给定字符串的 Unicode 规范化形式的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"normalize_1":{"name":"### normalize(form?)","description":"normalize() 方法会按照指定的一种 Unicode 正规形式将当前字符串规范化。（如果该值不是字符串，则首先将其转换为一个字符串）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| form | string | 是 | - | - | 四种 Unicode 正规形式（Unicode Normalization Form）\"NFC\"、\"NFD\"、\"NFKC\"，或 \"NFKD\" 其中的一个，默认值为 \"NFC\"。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 含有给定字符串的 Unicode 规范化形式的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"repeat":{"name":"### repeat(count)","description":"repeat() 构造并返回一个新字符串，该字符串包含被连接在一起的指定数量的字符串的副本。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| count | number | 是 | - | - | 介于 0 和 +Infinity 之间的整数。表示在新构造的字符串中重复了多少遍原字符串。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含指定字符串的指定数量副本的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"startsWith":{"name":"### startsWith(searchString, position?)","description":"startsWith() 方法用来判断当前字符串是否以另外一个给定的子字符串开头，并根据判断结果返回 true 或 false。这个方法区分大小写。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchString | string | 是 | - | - | 要搜索的子字符串。 |\n| position | number | 是 | - | - | 在 str 中搜索 searchString 的开始位置，默认值为 0。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果在字符串的开头找到了给定的字符则返回 true；否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"anchor":{"name":"### anchor(name)","description":"anchor() 方法创建一个 \\ HTML 锚元素，被用作超文本靶标（hypertext target）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | 一个字符串，表示被创建的标签的 name 属性。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含 \\ HTML 元素的一个字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"big":{"name":"### big()","description":"创建一个使字符串显示大号字体的\\标签。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 带有 \\标签的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"blink":{"name":"### blink()","description":"blink() 方法创建一个字符串，其在 \\str\\ 中嵌入字符串，这使得字符串在旧版浏览器中闪烁。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含 \\ HTML 元素的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"bold":{"name":"### bold()","description":"bold() 方法会创建 HTML 元素“b”，并将字符串加粗展示。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含 HTML 元素 \\ 的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"fixed":{"name":"### fixed()","description":"fixed() 方法创建了一个 \\ 标签元素将字符串包裹起来，从而让这个字符串里面的内容具有固定间距。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个表示 \\ HTML 元素的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"fontcolor":{"name":"### fontcolor(color)","description":"创建一个\\的 HTML 元素让字符串被显示成指定的字体颜色。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| color | string | 是 | - | - | 代表颜色的一个字符串，可以是三个一组的十六进制的 RGB 值，也可以是一个颜色名称的字符串字面量. | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个包含一个\\ HTML 元素的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"fontsize":{"name":"### fontsize(size)","description":"返回一个' \\ ' HTML元素并设置size属性值","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| size | number | 是 | - | - | 1到7之间的整数。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含\\ HTML元素的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"fontsize_1":{"name":"### fontsize(size)","description":"返回一个' \\ ' HTML元素并设置size属性值","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| size | string | 是 | - | - | 表示1到7之间的有符号整数的字符串。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含\\ HTML元素的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"italics":{"name":"### italics()","description":"italics()方法创建一个\\ HTML元素，使字符串变为斜体。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个\\ HTML元素，使字符串变为斜体。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"link":{"name":"### link(url)","description":"link() 方法创建一个 HTML 元素 \\ ，用该字符串作为超链接的显示文本，参数作为指向另一个 URL 的超链接。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| url | string | 是 | - | - | 任何能够指定 a 标签的 href 属性的字符串；它应当是有效的 URL（相对或绝对），任何 & 字符将会被转义为 &，任何 \" 字符将会被转义为 "。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个带有一个 HTML 元素 \\ 的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"small":{"name":"### small()","description":"small() 方法的作用是创建一个使字符串显示小号字体的 \\ 标签。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 带有 \\ 标签的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"strike":{"name":"### strike()","description":"strike()方法创建\\ HTML 元素，使字符串展示为被删除的文本。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含\\ HTML 元素的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"sub":{"name":"### sub()","description":"sub()方法创建一个 \\ HTML 元素，使字符串展示为下标。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含\\ HTML 元素的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"sup":{"name":"### sup()","description":"sup()方法创建 一个\\HTML 元素，使字符串显示为上标。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 包含\\ HTML 元素的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"at":{"name":"### at(index)","description":"方法接受一个整数值，并返回一个新的 String，该字符串由位于指定偏移量处的单个 UTF-16 码元组成","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| index | number | 是 | - | - | 字符指定偏移量处，允许正整数和负整数，负整数从字符串中的最后一个字符开始倒数。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string \\| null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"fromCharCode":{"name":"### fromCharCode(...codes)","description":"","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| codes | number[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | - | √ | 3.9+ | - |\n","itemType":"method"}},"Number":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Number)","MAX_VALUE":{"name":"### MAX_VALUE","description":"在 JavaScript 里所能表示的最大数值。无限接近于 1.79E+308。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"MIN_VALUE":{"name":"### MIN_VALUE","description":"表示在 JavaScript 中所能表示的最小的正值。 无限接近于 5.00E-324。
","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"NaN":{"name":"### NaN","description":"表示“非数字”（Not-A-Number）。和 NaN 相同。
在相等比较中，NaN不等于任何值，包括它自己。要测试一个值是否等于NaN，使用isNaN函数。
","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"NEGATIVE_INFINITY":{"name":"### NEGATIVE_INFINITY","description":"表示负无穷大。
Number.NEGATIVE_INFINITY 的值和全局对象的 Infinity 属性的负值相同。
","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"POSITIVE_INFINITY":{"name":"### POSITIVE_INFINITY","description":"表示正无穷大。
Number.POSITIVE_INFINITY 的值同全局对象 Infinity 属性的值相同。
","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"toString":{"name":"### toString(radix?)","description":"返回指定 Number 对象的字符串表示形式。如果转换的基数大于 10，则会使用字母来表示大于 9 的数字，比如基数为 16 的情况，则使用 a 到 f 的字母来表示 10 到 15。如果基数没有指定，则使用 10。如果对象是负数，则会保留负号。即使 radix 是 2 时也是如此：返回的字符串包含一个负号（-）前缀和正数的二进制表示，不是 数值的二进制补码。进行数字到字符串的转换时，建议用小括号将要转换的目标括起来，防止出错。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| radix | number | 是 | - | - | 指定要用于数字到字符串的转换的基数 (从 2 到 36)。如果未指定 radix 参数，则默认值为 10。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"toFixed":{"name":"### toFixed(fractionDigits?)","description":"使用定点表示法来格式化一个数值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| fractionDigits | number | 是 | - | - | 小数点后数字的个数；介于 0 到 20（包括）之间，实现环境可能支持更大范围。如果忽略该参数，则默认为 0。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 使用定点表示法表示给定数字的字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"toExponential":{"name":"### toExponential(fractionDigits?)","description":"以指数表示法返回该数值字符串表示形式。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| fractionDigits | number | 是 | - | - | 可选。一个整数，用来指定小数点后有几位数字。默认情况下用尽可能多的位数来显示数字。如果 fractionDigits 太小或太大将会抛出该错误。必须介于 0 和 20（包括 20）之间。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个用幂的形式 (科学记数法) 来表示Number 对象的字符串。小数点后以 fractionDigits 提供的值来四舍五入。如果 fractionDigits 参数被忽略了，小数点后的将尽可能用最多的位数来表示该数值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"toPrecision":{"name":"### toPrecision(precision?)","description":"以指定的精度返回该数值对象的字符串表示。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| precision | number | 是 | - | - | 一个用来指定有效数个数的整数。 必须介于 1 到 21 之间。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 以定点表示法或指数表示法表示的一个数值对象的字符串表示，四舍五入到 precision 参数指定的显示数字位数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"valueOf":{"name":"### valueOf()","description":"返回一个被 Number 对象包装的原始值。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 表示指定 Number 对象的原始值的数字。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"toInt":{"name":"### toInt()","description":"返回一个Int 值","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Int | 返回 number 对应的 Int 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | x | √ | √ | x |\n","itemType":"method"},"toFloat":{"name":"### toFloat()","description":"返回一个Float 值","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Float | 返回 number 对应的 Float 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | x | √ | √ | x |\n","itemType":"method"},"toDouble":{"name":"### toDouble()","description":"返回一个 Double 值","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Double | 返回 number 对应的 Double 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | x | √ | √ | x |\n","itemType":"method"},"toInt64":{"name":"### toInt64()","description":"返回一个 Int64 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Int64 | 返回 number 对应的 Int64 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | x | x | 3.9+ | x |\n","itemType":"method"},"toInt32":{"name":"### toInt32()","description":"返回一个 Int32 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Int32 | 返回 number 对应的 Int32 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | x | x | 3.9+ | x |\n","itemType":"method"},"toInt16":{"name":"### toInt16()","description":"返回一个 Int16 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Int16 | 返回 number 对应的 Int16 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | x | x | 3.9+ | x |\n","itemType":"method"},"toInt8":{"name":"### toInt8()","description":"返回一个 Int8 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Int8 | 返回 number 对应的 Int8 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | x | x | 3.9+ | x |\n","itemType":"method"},"toUInt":{"name":"### toUInt()","description":"返回一个 UInt 值","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UInt | 返回 number 对应的 UInt 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | x | √ | 3.9+ | x |\n","itemType":"method"},"toUInt64":{"name":"### toUInt64()","description":"返回一个 UInt64 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UInt64 | 返回 number 对应的 UInt64 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | x | x | 3.9+ | x |\n","itemType":"method"},"toUInt32":{"name":"### toUInt32()","description":"返回一个 UInt32 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UInt32 | 返回 number 对应的 UInt32 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | x | x | 3.9+ | x |\n","itemType":"method"},"toUInt16":{"name":"### toUInt16()","description":"返回一个 UInt16 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UInt16 | 返回 number 对应的 UInt16 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | x | x | 3.9+ | x |\n","itemType":"method"},"toUInt8":{"name":"### toUInt8()","description":"返回一个 UInt8 值, app-iOS平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UInt8 | 返回 number 对应的 UInt8 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | x | x | 3.9+ | x |\n","itemType":"method"},"toByte":{"name":"### toByte()","description":"将当前的Number数据转换为Byte表示，如果超出Byte最大值表示范围，会得到溢出后余数表示, app-andorid平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Byte | 返回 number 对应的 Byte 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | x | √ | x | x |\n","itemType":"method"},"toLong":{"name":"### toLong()","description":"将当前的Number数据转换为Long表示，如果超出Long最大值表示范围，会得到溢出后余数表示, app-andorid平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Long | 返回 number 对应的 Long 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | x | √ | x | x |\n","itemType":"method"},"toShort":{"name":"### toShort()","description":"将当前的Number数据转换为Short表示，如果超出Short最大值表示范围，会得到溢出后余数表示, app-andorid平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Short | 返回 number 对应的 Short 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | x | √ | x | x |\n","itemType":"method"},"toUShort":{"name":"### toUShort()","description":"将当前的 Number 数据转换为 UShort 表示，如果超出 UShort 最大值表示范围，会得到溢出后余数表示, app-andorid平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UShort | 返回 number 对应的 UShort 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | x | √ | x | x |\n","itemType":"method"},"toULong":{"name":"### toULong()","description":"将当前的 Number 数据转换为 ULong 表示，如果超出 ULong 最大值表示范围，会得到溢出后余数表示, app-andorid平台特有。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| ULong | 返回 number 对应的 ULong 值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | x | √ | x | x |\n","itemType":"method"},"from":{"name":"### from(value)","description":"通过 Int \\| Float \\| Double \\| Int64 \\| Int32 \\| Int16 \\| Int8 \\| UInt \\| UInt64 \\| UInt32 \\| UInt16 \\| UInt8 \\| Byte \\| Short \\| Long 类型创建一个 number","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | Int \\| Float \\| Double \\| Int64 \\| Int32 \\| Int16 \\| Int8 \\| UInt \\| UInt64 \\| UInt32 \\| UInt16 \\| UInt8 \\| Byte \\| Short \\| Long | 是 | - | - | 必填。一个 Swfit 或者 Kottlin 专有数字类型的值。其中 Swift 平台 支持 Int, Float, Double, Int64, Int32, Int16, Int8, UInt, UInt64, UInt32, UInt16, UInt8。Kottlin 平台支持 Int, Float, Double, Byte, Short, Long | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回 number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | x | 3.9+ | 3.9+ | x |\n","itemType":"method"}},"Math":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Math)","E":{"name":"### E","description":"Math.E 属性表示自然对数的底数（或称为基数），e，约等于 2.718。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"LN10":{"name":"### LN10","description":"Math.LN10 属性表示 10 的自然对数，约为 2.302
","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"LN2":{"name":"### LN2","description":"Math.LN2 属性表示 2 的自然对数，约为 0.693","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"LOG2E":{"name":"### LOG2E","description":"Math.LOG2E 属性表示以 2 为底数，e 的对数，约为 1.442","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"LOG10E":{"name":"### LOG10E","description":"Math.LOG10E 属性表示以 10 为底数，e 的对数，约为 0.434","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"PI":{"name":"### PI","description":"Math.PI 表示一个圆的周长与直径的比例，约为 3.14159","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"SQRT1_2":{"name":"### SQRT1_2","description":"Math.SQRT1_2 属性表示 1/2 的平方根，约为 0.707","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"SQRT2":{"name":"### SQRT2","description":"Math.SQRT2 属性表示 2 的平方根，约为 1.414","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"abs":{"name":"### abs(x)","description":"RMath.abs(x) 函数返回一个数字的绝对值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数字 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | x 的绝对值。如果 x 是负数（包括 -0），则返回 -x。否则，返回 x | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"acos":{"name":"### acos(x)","description":"Math.acos() 返回一个数的反余弦值（单位为弧度）","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值. | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"asin":{"name":"### asin(x)","description":"Math.asin() 方法返回一个数值的反正弦（单位为弧度）","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"atan":{"name":"### atan(x)","description":"Math.atan() 函数返回一个数值的反正切（以弧度为单位）","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"atan2":{"name":"### atan2(y, x)","description":"Math.atan2() 返回从原点 (0,0) 到 (x,y) 点的线段与 x 轴正方向之间的平面角度 (弧度值)，也就是 Math.atan2(y,x)","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| y | number | 是 | - | - | 数值 |\n| x | number | 是 | - | - | 数值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"ceil":{"name":"### ceil(x)","description":"Math.ceil() 函数总是四舍五入并返回大于等于给定数字的最小整数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"cos":{"name":"### cos(x)","description":"Math.cos() 函数返回一个数值的余弦值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个以弧度为单位的数值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"exp":{"name":"### exp(x)","description":"Math.exp() 函数返回 e^x，x 表示参数，e 是欧拉常数（Euler's constant），自然对数的底数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"floor":{"name":"### floor(x)","description":"Math.floor() 函数总是返回小于等于一个给定数字的最大整数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"log":{"name":"### log(x)","description":"Math.log() 函数返回一个数的自然对数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"max":{"name":"### max(...values)","description":"Math.max() 函数返回作为输入参数的最大数字，如果没有参数，则返回 -Infinity","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| values | number[\\] | 是 | - | - | 0 个或多个数字，将在其中选择，并返回最大的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 给定数值中最大的数。如果任一参数不能转换为数值，则返回 NaN。如果没有提供参数，返回 -Infinity。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"min":{"name":"### min(...values)","description":"Math.min() 函数返回作为输入参数的数字中最小的一个，如果没有参数，则返回 Infinity。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| values | number[\\] | 是 | - | - | 0 个或多个数字，将在其中选择，并返回最小值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 给定数值中最小的数。如果任一参数不能转换为数值，则返回 NaN。如果没有提供参数，返回 Infinity。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"pow":{"name":"### pow(x, y)","description":"Math.pow() 函数返回基数（base）的指数（exponent）次幂，即 base^exponent。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 基数 |\n| y | number | 是 | - | - | 指数 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"random":{"name":"### random()","description":"Math.random() 函数返回一个浮点数，伪随机数在范围从0 到小于1，也就是说，从 0（包括 0）往上，但是不包括 1（排除 1），然后您可以缩放到所需的范围。实现将初始种子选择到随机数生成算法;它不能被用户选择或重置。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 一个浮点型伪随机数字，在0（包括 0）和1（不包括）之间。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"round":{"name":"### round(x)","description":"Math.round() 函数返回一个数字四舍五入后最接近的整数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 给定数字的值四舍五入到最接近的整数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"sin":{"name":"### sin(x)","description":"Math.sin() 函数返回一个数值的正弦值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值（以弧度为单位）。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"sqrt":{"name":"### sqrt(x)","description":"Math.sqrt() 函数返回一个数的平方根","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"tan":{"name":"### tan(x)","description":"Math.tan() 方法返回一个数值的正切值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值，表示一个角（单位：弧度）。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"clz32":{"name":"### clz32(x)","description":"Math.clz32() 函数返回一个数字在转换成 32 无符号整形数字的二进制形式后，开头的 0 的个数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"imul":{"name":"### imul(x, y)","description":"该函数将两个参数分别转换为 32 位整数，相乘后返回 32 位结果，类似 C 语言的 32 位整数相乘。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 被乘数。 |\n| y | number | 是 | - | - | 乘数。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | x |\n","itemType":"method"},"sign":{"name":"### sign(x)","description":"Math.sin() 函数返回一个数值的正弦值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值（以弧度为单位）。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"log10":{"name":"### log10(x)","description":"Math.log10() 函数返回一个数字以 10 为底的对数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 任意数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"log2":{"name":"### log2(x)","description":"Math.log2() 函数返回一个数字以 2 为底的对数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 任意数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"log1p":{"name":"### log1p(x)","description":"Math.log1p() 函数返回一个数字加 1 后的自然对数 (底为 E), 既log(x+1).","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 任意数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"expm1":{"name":"### expm1(x)","description":"Math.expm1() 函数返回 E^x - 1, 其中 x 是该函数的参数，E 是自然对数的底数 2.718281828459045。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 任意数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"cosh":{"name":"### cosh(x)","description":"Math.cosh() 函数返回数值的双曲余弦函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 数值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"sinh":{"name":"### sinh(x)","description":"Math.sinh() 函数返回一个数字 (单位为角度) 的双曲正弦值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 任意数字 (单位为度). | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"tanh":{"name":"### tanh(x)","description":"Math.tanh() 函数将会返回一个数的双曲正切函数值","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 待计算的数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"acosh":{"name":"### acosh(x)","description":"Math.acosh() 函数返回一个数的反双曲余弦值","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"asinh":{"name":"### asinh(x)","description":"Math.asinh() 返回一个数值的反双曲正弦值","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"atanh":{"name":"### atanh(x)","description":"Math.atanh() 函数返回一个数值反双曲正切值","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个数值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"hypot":{"name":"### hypot(...values)","description":"Math.hypot() 函数返回所有参数的平方和的平方根","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| values | number[\\] | 是 | - | - | 任意个数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | x |\n","itemType":"method"},"trunc":{"name":"### trunc(x)","description":"Math.trunc() 方法会将数字的小数部分去掉，只保留整数部分。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 任意数字 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"fround":{"name":"### fround(x)","description":"Math.fround() 可以将任意的数字转换为离它最近的单精度浮点数形式的数字。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 一个 Number。若参数为非数字类型，则会被转投成数字。无法转换时，设置成NaN。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | 3.9+ | x |\n","itemType":"method"},"cbrt":{"name":"### cbrt(x)","description":"Math.cbrt() 函数返回任意数字的立方根。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | number | 是 | - | - | 任意数字。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | x |\n","itemType":"method"}},"Date":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Date)","toString":{"name":"### toString()","description":"返回一个字符串，以本地的时区表示该 Date 对象。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"toDateString":{"name":"### toDateString()","description":"以美式英语和人类易读的形式返回一个日期对象日期部分的字符串。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"toTimeString":{"name":"### toTimeString()","description":"以人类易读形式返回一个日期对象时间部分的字符串，该字符串以美式英语格式化。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"toLocaleString":{"name":"### toLocaleString()","description":"返回该日期对象的字符串，该字符串格式因不同语言而不同。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"toLocaleDateString":{"name":"### toLocaleDateString()","description":"返回指定日期对象日期部分的字符串，该字符串格式因不同语言而不同。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"toLocaleTimeString":{"name":"### toLocaleTimeString()","description":"返回该日期对象时间部分的字符串，该字符串格式因语言而异。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"valueOf":{"name":"### valueOf()","description":"返回从UTC时间1970年1月1日午夜开始以毫秒为单位存储的时间值。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getTime":{"name":"### getTime()","description":"返回从UTC时间1970年1月1日午夜开始以毫秒为单位存储的时间值。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"getFullYear":{"name":"### getFullYear()","description":"根据本地时间返回指定日期的年份。此方法替代 getYear() 。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 根据当地时间，返回一个对应于给定日期的年份数字。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"getUTCFullYear":{"name":"### getUTCFullYear()","description":"以世界时为标准，返回一个指定的日期对象的年份。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getMonth":{"name":"### getMonth()","description":"根据本地时间，返回一个指定的日期对象的月份，为基于 0 的值（0 表示一年中的第一月）。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 一个 0 到 11 的整数值：0 代表一月份，1 代表二月份，2 代表三月份，依次类推。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"getUTCMonth":{"name":"### getUTCMonth()","description":"以世界时为标准，返回一个指定的日期对象的月份，它是从 0 开始计数的（0 代表一年的第一个月）。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 11 的整数，分别对应以下月份：0 代表一月，1 代表二月，2 代表三月，依次类推。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getDate":{"name":"### getDate()","description":"根据本地时间，返回一个指定的日期对象为一个月中的哪一日（从 1--31）。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 1 到 31 的整数值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"getUTCDate":{"name":"### getUTCDate()","description":"以世界时为标准，返回一个指定的日期对象为一个月中的第几天","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 1 到 31 的整数值 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getDay":{"name":"### getDay()","description":"根据本地时间，返回一个具体日期中一周的第几天，0 表示星期天。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 根据本地时间，返回一个 0 到 6 之间的整数值，代表星期几：0 代表星期日，1 代表星期一，2 代表星期二，依次类推。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"getUTCDay":{"name":"### getUTCDay()","description":"以世界时为标准，返回一个指定的日期对象为一星期中的第几天，其中 0 代表星期天。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个对应一星期中第几天的整数：0 代表星期天，1 代表星期一，2 代表星期二，依次类推。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getHours":{"name":"### getHours()","description":"根据本地时间，返回一个指定的日期对象的小时。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 23 之间的整数值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"getUTCHours":{"name":"### getUTCHours()","description":"以世界时为标准，返回一个指定的日期对象的小时数。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 23 的整数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getMinutes":{"name":"### getMinutes()","description":"根据本地时间，返回一个指定的日期对象的分钟数。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 59 的整数值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"getUTCMinutes":{"name":"### getUTCMinutes()","description":"以世界时为标准，返回一个指定的日期对象的分钟数。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 59 的整数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getSeconds":{"name":"### getSeconds()","description":"根据本地时间，返回一个指定的日期对象的秒数。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 59 的整数值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"getUTCSeconds":{"name":"### getUTCSeconds()","description":"以世界时为标准，返回一个指定的日期对象的秒数。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 59 的整数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getUTCMilliseconds":{"name":"### getUTCMilliseconds()","description":"以世界时为标准，返回一个指定的日期对象的毫秒数。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回一个 0 到 999 的整数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"getTimezoneOffset":{"name":"### getTimezoneOffset()","description":"返回协调世界时（UTC）相对于当前时区的时间差值，单位为分钟。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 时区偏差（time-zone offset）表示协调世界时（UTC）与本地时区之间的差值，单位为分钟。需要注意的是如果本地时区后于协调世界时，则该差值为正值，如果先于协调世界时则为负值。例如你所在时区为 UTC+10（澳大利亚东部标准时间），将会返回 -600。对于同一个时区，夏令时（Daylight Saving Time）将会改变这个值。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"setTime":{"name":"### setTime(time)","description":"以一个表示从 1970-1-1 00:00:00 UTC 计时的毫秒数为来为 Date 对象设置时间。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| time | number | 是 | - | - | 一个整数，表示从 1970-1-1 00:00:00 UTC 开始计时的毫秒数。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | UTC 1970 年 1 月 1 日 00:00:00 与更新日期之间的毫秒数（实际上是自变量的值）。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"setMilliseconds":{"name":"### setMilliseconds(ms)","description":"根据本地时间设置一个日期对象的豪秒数。如果指定的数字超出了合理范围，则日期对象的时间信息会被相应地更新。例如，如果指定了 1005，则秒数加 1，豪秒数为 5。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| ms | number | 是 | - | - | 一个 0 到 999 的数字，表示豪秒数。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回更新后的时间距 1970 年 1 月 1 日 00:00:00 的毫秒数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"setUTCMilliseconds":{"name":"### setUTCMilliseconds(ms)","description":"根据世界时来设置指定时间的毫秒数。如果传递的参数超出了指定的范围，setUTCMilliseconds() 方法会相应地尝试更新储存在 Date 的时间信息。例如，假设你传递参数的值是 1100，存储在 Date 的秒数会加 1，然后使用 100 来作为毫秒数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| ms | number | 是 | - | - | 0 - 999 之间的数值，代表毫秒数。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回更新后的时间距 1970 年 1 月 1 日 00:00:00 (UTC) 的毫秒数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"setSeconds":{"name":"### setSeconds(sec)","description":"根据本地时间设置一个日期对象的秒数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| sec | number | 是 | - | - | 一个 0 到 59 的整数。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"setUTCSeconds":{"name":"### setUTCSeconds(sec)","description":"为一个依据国际通用时间的特定日期设置秒数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| sec | number | 是 | - | - | 一个在 0 到 59 之间的整数，表示秒数。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"setMinutes":{"name":"### setMinutes(min)","description":"根据本地时间为一个日期对象设置分钟数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| min | number | 是 | - | - | 一个 0 到 59 的整数，表示分钟数。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"setUTCMinutes":{"name":"### setUTCMinutes(min)","description":"根据世界协调时（UTC）来设置指定日期的分钟数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| min | number | 是 | - | - | 必填，表示要设置的分钟数，是一个介于 0 和 59 之间的整数。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回从 UTC 时间 1970 年 1 月 1 日 0 时 0 分 0 秒至设置后的时间的毫秒数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"setHours":{"name":"### setHours(hours)","description":"根据本地时间为一个日期对象设置小时数，返回从 1970-01-01 00:00:00 UTC 到更新后的 日期 对象实例所表示时间的毫秒数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| hours | number | 是 | - | - | 必填，一个 0 到 23 的整数，表示小时。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"setUTCHours":{"name":"### setUTCHours(hours)","description":"根据世界协调时（UTC）为一个日期对象设置小时数，返回从 1970-01-01 00:00:00 UTC 到更新后的 日期 对象实例所表示时间的毫秒数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| hours | number | 是 | - | - | 必填，表示小时的整数，取值 0 到 23 之间。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回从 1970-01-01 00:00:00 UTC 到更新后的日期所表示时间的毫秒数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"setDate":{"name":"### setDate(date)","description":"根据本地时间来指定一个日期对象的天数。如果 dayValue 超出了月份的合理范围，setDate 将会相应地更新 Date 对象。例如，如果为 dayValue 指定 0，那么日期就会被设置为上个月的最后一天。如果 dayValue 被设置为负数，日期会设置为上个月最后一天往前数这个负数绝对值天数后的日期。-1 会设置为上月最后一天的前一天（译者注：例如当前为 4 月，如果 setDate(-2),则为 3 月 29 日）","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| date | number | 是 | - | - | 一个整数，表示该月的第几天。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"setUTCDate":{"name":"### setUTCDate(date)","description":"根据全球时间设置特定 date 对象的日期。如果你指定的参数超出了范围，setUTCDate() 会尝试更新对应的Date 中的日期信息。例如，如果你使用了 40 来作为参数，但是Date 中存储的月份为 6 月，那么日期将被改写为 10 且月份被增到 7 月。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| date | number | 是 | - | - | 一个 1-31 的整形数字，用来指定日期。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"setMonth":{"name":"### setMonth(month)","description":"根据本地时间为一个日期对象设置月份。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| month | number | 是 | - | - | 必填参数，介于 0 到 11 之间的整数（表示一月到十二月）。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 基于 1 January 1970 00:00:00 UTC 开始计算的毫秒数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"setUTCMonth":{"name":"### setUTCMonth(month)","description":"根据通用的时间（ UTC ）来设置一个准确的月份。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| month | number | 是 | - | - | 必填参数，一个 0-11 的整数，代表 1 月到 12 月。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 这个数值是从 1970 年 1 月 1 号 00:00:00 到当前时间的毫秒数（国际通用时间） | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"setFullYear":{"name":"### setFullYear(year)","description":"根据本地时间为一个日期对象设置年份。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| year | number | 是 | - | - | 指定年份的整数值，例如 1995。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | √ |\n","itemType":"method"},"setUTCFullYear":{"name":"### setUTCFullYear(year)","description":"根据世界标准时间 (UTC) 为一个具体日期设置年份。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| year | number | 是 | - | - | 指定年份整数值，例如，1995 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"toUTCString":{"name":"### toUTCString()","description":"把一个日期转换为一个字符串，使用 UTC 时区。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"toISOString":{"name":"### toISOString()","description":"一个 ISO（ISO 8601 Extended Format）格式的字符串： YYYY-MM-DDTHH:mm:ss.sssZ。时区总是 UTC（协调世界时），加一个后缀“Z”标识。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| √ | x | 4.0 | 4.11 | x | √ |\n","itemType":"method"},"toJSON":{"name":"### toJSON(key?)","description":"返回 Date 对象的字符串形式。调用 toJSON() 返回一个 JSON 格式字符串 (使用 toISOString())，表示该日期对象的值。默认情况下，这个方法常用于 JSON序列化Date对象。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | any | 否 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| √ | x | 4.0 | 4.11 | x | √ |\n","itemType":"method"},"parse":{"name":"### parse(s)","description":"解析一个表示某个日期的字符串，并返回从 1970-1-1 00:00:00 UTC 到该日期对象（该日期对象的 UTC 时间）的毫秒数，如果该字符串无法识别，或者一些情况下，包含了不合法的日期数值（如：2015-02-31），则返回值为 NaN。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| s | string | 是 | - | - | 一个符合 RFC2822 或 ISO 8601 日期格式的字符串（其他格式也许也支持，但结果可能与预期不符）。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 一个表示从 1970-1-1 00:00:00 UTC 到给定日期字符串所表示时间的毫秒数的数值。如果参数不能解析为一个有效的日期，则返回NaN。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"UTC":{"name":"### UTC(year, monthIndex, date?, hours?, minutes?, seconds?, ms?)","description":"接受的参数同 Date 构造函数接受最多参数时一样，但该前者会视它们为 UTC 时间，其返回从 1970 年 1 月 1 日 00:00:00 UTC 到指定时间的毫秒数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| year | number | 是 | - | - | 一个表示年份的整数值。从 0 到 99 的值会被映射到 1900 至 1999 年。其他的值则代表实际的年份。 |\n| monthIndex | number | 是 | - | - | 0（一月）到 11（十二月）之间的一个整数，表示月份。从 ECMAScript 2017 开始，如果忽略该值，则默认为 0。（直到 ECMAScript 2016，month 都是必须的参数。而从 ES2017 开始，它不再是必须的。） |\n| date | number | 是 | - | - | 1 到 31 之间的一个整数，表示某月当中的第几天。如果忽略该值，则默认为 1。 |\n| hours | number | 是 | - | - | 0 到 23 之间的一个整数，表示小时。如果忽略该值，则默认为 0。 |\n| minutes | number | 是 | - | - | 0 到 59 之间的一个整数，表示分钟。如果忽略该值，则默认为 0。 |\n| seconds | number | 是 | - | - | 0 到 59 之间的一个整数，表示秒。如果忽略该值，则默认为 0。 |\n| ms | number | 是 | - | - | 0 到 999 之间的一个整数，表示毫秒。如果忽略该值，则默认为 0。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 一个数字，表示从 1970 年 1 月 1 日 00:00:00 UTC 到给定时间的毫秒数。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"now":{"name":"### now()","description":"返回自 1970 年 1 月 1 日 00:00:00 (UTC) 到当前时间的毫秒数。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"}},"RegExp":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.RegExp)","flags":{"name":"### flags","description":"返回一个字符串，由当前正则表达式对象的标志组成。此属性是一个只读属性
此字符串中的字符按以下顺序排序和连接:

- \"g\" for global
- \"i\" for ignoreCase
- \"m\" for multiline
- \"u\" for unicode
- \"y\" for sticky

如果没有设置标志，则该值为空字符串。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"dotAll":{"name":"### dotAll","description":"表明是否在正则表达式中一起使用\"s\"修饰符（引入/s 修饰符，使得。可以匹配任意单个字符）。dotAll 是一个只读的属性，属于单个正则表达式实例。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"hasIndices":{"name":"### hasIndices","description":"指示 d 标志是否与正则表达式一起使用。只读的。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"sticky":{"name":"### sticky","description":"搜索是否具有粘性（仅从正则表达式的 lastIndex 属性表示的索引处搜索）。sticky 是正则表达式对象的只读属性。默认为false。只读的。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"unicode":{"name":"### unicode","description":"表明正则表达式带有\"u\" 标志。 unicode 是正则表达式独立实例的只读属性。unicode 的值是 Boolean，并且如果使用了 \"u\" 标志则为 true；否则为 false。\"u\" 标志开启了多种 Unicode 相关的特性。使用 \"u\" 标志，任何 Unicode 代码点的转义都会被解释。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"prop"},"source":{"name":"### source","description":"返回一个值为当前正则表达式对象的模式文本的字符串，该字符串不会包含正则字面量两边的斜杠以及任何的标志字符。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"global":{"name":"### global","description":"表明正则表达式是否使用了 \"g\" 标志。global 是一个正则表达式实例的只读属性。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"ignoreCase":{"name":"### ignoreCase","description":"表明正则表达式是否使用了 \"i\" 标志。ignoreCase 是正则表达式实例的只读属性。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"multiline":{"name":"### multiline","description":"表明正则表达式是否使用了 \"m\" 标志。multiline 是正则表达式实例的一个只读属性。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"lastIndex":{"name":"### lastIndex","description":"正则表达式的一个可读可写的整型属性，用来指定下一次匹配的起始索引。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"exec":{"name":"### exec(string)","description":"在一个指定字符串中执行一个搜索匹配。返回一个结果数组或 null。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| string | string | 是 | - | - | 要匹配正则表达式的字符串。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| RegExpExecArray \\| null | 如果匹配失败，exec() 方法返回 null，并将正则表达式的 lastIndex 重置为 0。如果匹配成功，exec() 方法返回一个数组，并更新正则表达式对象的 lastIndex 属性。完全匹配成功的文本将作为返回数组的第一项，从第二项起，后续每项都对应一个匹配的捕获组。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"test":{"name":"### test(string)","description":"执行一个检索，用来查看正则表达式与指定的字符串是否匹配。返回 true 或 false。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| string | string | 是 | - | - | 用来与正则表达式匹配的字符串。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果正则表达式与指定的字符串匹配，返回true；否则false。如果正则表达式设置了全局标志，test() 的执行会改变正则表达式 lastIndex属性。连续的执行test()方法，后续的执行将会从 lastIndex 处开始匹配字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"}},"JSON":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.JSON)","parse":{"name":"### parse(text, reviver?)","description":"JSON.parse() 方法用来解析 JSON 字符串，构造由字符串描述的 JavaScript 值或对象。提供可选的 reviver 函数用以在返回之前对所得到的对象执行变换 (操作)。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| text | string | 是 | - | - | 要被解析成 JavaScript 值的字符串 |\n| reviver | (this: any, key: string, value: any) => any | 是 | - | - | \\[可选]转换器，如果传入该参数 (函数)，可以用来修改解析生成的原始值，调用时机在 parse 函数返回之前。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| any \\| null | 返回一个any 或者 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"parse_1":{"name":"### parse(text)","description":"JSON.parse() 方法用来解析 JSON 字符串，构造由字符串描述的值或者对象，其类型由泛型参数T决定
如果输入的是一个合法的json值或者对象，返回一个对应的T值或者对象，如果json描述的值或对象和 T 指定的类型不符，将返回null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| text | string | 是 | - | - | 要被解析成 JavaScript 值的字符串 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T \\| null | 返回一个T类型的值或者对象 或者 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | x |\n","itemType":"method"},"parseObject":{"name":"### parseObject(text)","description":"JSON.parseObject() 方法用来解析 JSON 字符串，构造由字符串描述的对象。
如果输入的是一个合法的json对象，返回一个对应的UTSJSONObject，如果是json array 或者其他格式的字符串返回null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| text | string | 是 | - | - | 要被解析成 JavaScript 值的字符串 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UTSJSONObject \\| null | 返回一个UTSJSONObjet 或者 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | x |\n","itemType":"method"},"parseObject_1":{"name":"### parseObject(text)","description":"JSON.parseObject() 方法用来解析 JSON 字符串，构造由字符串描述的对象，该对象的类型由泛型参数T决定
如果输入的是一个合法的json对象，返回一个对应的T对象，如果是json array 或者其他格式的字符串返回null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| text | string | 是 | - | - | 要被解析成 JavaScript 值的字符串 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T \\| null | 返回一个T类型对象 或者 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | x |\n","itemType":"method"},"parseArray":{"name":"### parseArray(text)","description":"JSON.parseArray() 方法用来解析 JSON 字符串，构造由字符串描述的数组。数组元素类型为any
如果输入的是一个合法的json数组，返回一个对应的Array，如果是json object 或者其他格式的字符串返回null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| text | string | 是 | - | - | 要被解析成 JavaScript 值的字符串 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Array\\ \\| null | 返回一个Array 或者 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | x |\n","itemType":"method"},"parseArray_1":{"name":"### parseArray(text)","description":"JSON.parseArray() 方法用来解析 JSON 字符串，构造由字符串描述的数组。数组元素类型由泛型T决定
如果输入的是一个合法的json数组，返回一个对应的Array，如果是json object 或者其他格式的字符串返回null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| text | string | 是 | - | - | 要被解析成 JavaScript 值的字符串 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Array\\ \\| null | 返回一个Array 或者 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | x |\n","itemType":"method"},"stringify":{"name":"### stringify(value)","description":"JSON.stringify() 方法将一个 JavaScript 对象或值转换为 JSON 字符串，如果指定了一个 replacer 函数，则可以选择性地替换值，或者指定的 replacer 是数组，则可选择性地仅包含数组指定的属性","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | any \\| null | 否 | - | - | 将要序列化成 一个 JSON 字符串的值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"}},"Array":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Array)","length":{"name":"### length","description":"length 是 Array 的实例属性，表示该数组中元素的个数。该值是一个无符号 32 位整数，并且其数值总是大于数组最大索引。","param":"","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"toString":{"name":"### toString()","description":"toString() 方法返回一个字符串，表示指定的数组及其元素。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"toKotlinList":{"name":"### toKotlinList()","description":"toKotlinList() 将当前的Array对象转换为 kotlin 中对应的List对象","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| kotlin.collections.List\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"add":{"name":"### add(item)","description":"将指定的元素追加到此列表的末尾","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| item | T | 是 | - | - | 添加到数组的元素。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 是否成功添加 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"toLocaleString":{"name":"### toLocaleString()","description":"toLocaleString() 方法返回一个字符串，表示数组中的所有元素。每个元素通过调用它们自己的 toLocaleString 方法转换为字符串，并且使用特定于语言环境的字符串（例如逗号“,”）分隔开。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"joinToString":{"name":"### joinToString(separator)","description":"从所有元素中使用\\[separator]建字符串","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| separator | string | 是 | - | - | 分隔符 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 拼接完成的字符串 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"pop":{"name":"### pop()","description":"pop() 方法从数组中删除最后一个元素，并返回该元素的值。此方法会更改数组的长度。
","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T \\| null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"push":{"name":"### push(...items)","description":"push() 方法将指定的元素添加到数组的末尾，并返回新的数组长度。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| items | T[\\] | 是 | - | - | 添加到数组末尾的元素。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 调用方法的对象的新 length 属性。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"concat":{"name":"### concat(...items)","description":"concat() 方法用于合并两个或多个数组。此方法不会更改现有数组，而是返回一个新数组。
","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| items | ConcatArray\\[\\] | 是 | - | - | 数组和/或值，将被合并到一个新的数组中。如果省略了所有 valueN 参数，则 concat 会返回调用此方法的现存数组的一个浅拷贝。详情请参阅下文描述。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T[\\] | 新的 Array 实例。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"concat_1":{"name":"### concat(...items)","description":"concat() 方法用于合并两个或多个数组。此方法不会更改现有数组，而是返回一个新数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| items | (T \\| ConcatArray\\)[\\] | 是 | - | - | 数组和/或值，将被合并到一个新的数组中。如果省略了所有 valueN 参数，则 concat 会返回调用此方法的现存数组的一个浅拷贝。详情请参阅下文描述。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T[\\] | 新的 Array 实例。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"join":{"name":"### join(separator?)","description":"join() 方法将一个数组（或一个类数组对象）的所有元素连接成一个字符串并返回这个字符串，用逗号或指定的分隔符字符串分隔。如果数组只有一个元素，那么将返回该元素而不使用分隔符。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| separator | string | 是 | - | - | 指定一个字符串来分隔数组的每个元素。如果需要，将分隔符转换为字符串。如果省略，数组元素用逗号（,）分隔。如果 separator 是空字符串（\"\"），则所有元素之间都没有任何字符。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个所有数组元素连接的字符串。如果 arr.length 为 0，则返回空字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | - | √ | √ | - |\n","itemType":"method"},"reverse":{"name":"### reverse()","description":"reverse() 方法就地反转数组中的元素，并返回同一数组的引用。数组的第一个元素会变成最后一个，数组的最后一个元素变成第一个。换句话说，数组中的元素顺序将被翻转，变为与之前相反的方向。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T[\\] | 原始数组反转后的引用。注意，数组是就地反转的，并且没有复制。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"shift":{"name":"### shift()","description":"shift() 方法从数组中删除第一个元素，并返回该元素的值。此方法更改数组的长度。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T \\| null | 从数组中删除的元素；如果数组为空则返回 null。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"slice":{"name":"### slice(start?, end?)","description":"slice() 方法返回一个新的数组对象，这一对象是一个由 start 和 end 决定的原数组的浅拷贝（包括 start，不包括 end），其中 start 和 end 代表了数组元素的索引。原始数组不会被改变。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| start | number | 是 | - | - | 提取起始处的索引（从 0 开始），会转换为整数。 |\n| end | number | 是 | - | - | 提取终止处的索引（从 0 开始），会转换为整数。slice() 会提取到但不包括 end 的位置。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"sort":{"name":"### sort(compareFn?)","description":"sort() 方法就地对数组的元素进行排序，并返回对相同数组的引用。默认排序是将元素转换为字符串，然后按照它们的 UTF-16 码元值升序排序。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| compareFn | (a: T, b: T) => number | 是 | - | - | 定义排序顺序的函数。返回值应该是一个数字，其正负性表示两个元素的相对顺序。该函数使用以下参数调用：
a:第一个用于比较的元素。不会是 null。
b:第二个用于比较的元素。不会是 null。
如果省略该函数，数组元素会被转换为字符串，然后根据每个字符的 Unicode 码位值进行排序。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| this | 经过排序的原始数组的引用。注意数组是就地排序的，不会进行复制。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"splice":{"name":"### splice(start, deleteCount?)","description":"splice() 方法通过移除或者替换已存在的元素和/或添加新元素就地改变一个数组的内容。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| start | number | 是 | - | - | 从 0 开始计算的索引，表示要开始改变数组的位置，它会被转换成整数。 |\n| deleteCount | number | 是 | - | - | 一个整数，表示数组中要从 start 开始删除的元素数量。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T[\\] | 一个包含了删除的元素的数组。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"splice_1":{"name":"### splice(start, deleteCount, ...items)","description":"splice() 方法通过移除或者替换已存在的元素和/或添加新元素就地改变一个数组的内容。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| start | number | 是 | - | - | 从 0 开始计算的索引，表示要开始改变数组的位置，它会被转换成整数。 |\n| deleteCount | number | 是 | - | - | 一个整数，表示数组中要从 start 开始删除的元素数量。 |\n| items | T[\\] | 是 | - | - | 添加到 arr 开头的元素。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T[\\] | 一个包含了删除的元素的数组。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"unshift":{"name":"### unshift(...items)","description":"unshift() 方法将指定元素添加到数组的开头，并返回数组的新长度。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| items | T[\\] | 是 | - | - | 添加到 arr 开头的元素。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"indexOf":{"name":"### indexOf(searchElement, fromIndex?)","description":"indexOf() 方法返回数组中第一次出现给定元素的下标，如果不存在则返回 -1。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchElement | T | 是 | - | - | 数组中要查找的元素。 |\n| fromIndex | number | 是 | - | - | 开始搜索的索引（从零开始），会转换为整数。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"lastIndexOf":{"name":"### lastIndexOf(searchElement, fromIndex?)","description":"lastIndexOf() 方法返回数组中给定元素最后一次出现的索引，如果不存在则返回 -1。该方法从 fromIndex 开始向前搜索数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchElement | T | 是 | - | - | 被查找的元素。 |\n| fromIndex | number | 是 | - | - | 以 0 起始的索引，表明反向搜索的起始位置，会被转换为整数。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"every":{"name":"### every(predicate, thisArg?)","description":"every() 方法测试一个数组内的所有元素是否都能通过指定函数的测试。它返回一个布尔值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index?: number, array?: Array\\) => boolean | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试，否则返回一个假值。该函数被调用时将传入以下参数：
value:数组中当前正在处理的元素。
index:正在处理的元素在数组中的索引。
array:调用了 every() 的数组本身。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| this is S[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"every_1":{"name":"### every(predicate, thisArg?)","description":"every() 方法测试一个数组内的所有元素是否都能通过指定函数的测试。它返回一个布尔值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number, array: Array\\) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试，否则返回一个假值。该函数被调用时将传入以下参数：
value:数组中当前正在处理的元素。
index:正在处理的元素在数组中的索引。
array:调用了 every() 的数组本身。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| boolean | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"every_2":{"name":"### every(predicate, thisArg?)","description":"every() 方法测试一个数组内的所有元素是否都能通过指定函数的测试。它返回一个布尔值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试，否则返回一个假值。该函数被调用时将传入以下参数：
value:数组中当前正在处理的元素。
index:正在处理的元素在数组中的索引。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| boolean | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"every_3":{"name":"### every(predicate, thisArg?)","description":"every() 方法测试一个数组内的所有元素是否都能通过指定函数的测试。它返回一个布尔值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试，否则返回一个假值。该函数被调用时将传入以下参数：
value:数组中当前正在处理的元素。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| boolean | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"some":{"name":"### some(predicate, thisArg?)","description":"some() 方法测试数组中是否至少有一个元素通过了由提供的函数实现的测试。如果在数组中找到一个元素使得提供的函数返回 true，则返回 true；否则返回 false。它不会修改数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number, array: Array\\) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试，否则返回一个假值。该函数被调用时将传入以下参数：
value:数组中当前正在处理的元素。
index:正在处理的元素在数组中的索引。
array:调用了 some() 的数组本身。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果回调函数对数组中至少一个元素返回一个真值，则返回 true。否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"some_1":{"name":"### some(predicate, thisArg?)","description":"some() 方法测试数组中是否至少有一个元素通过了由提供的函数实现的测试。如果在数组中找到一个元素使得提供的函数返回 true，则返回 true；否则返回 false。它不会修改数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试，否则返回一个假值。该函数被调用时将传入以下参数：
value:数组中当前正在处理的元素。
index:正在处理的元素在数组中的索引。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果回调函数对数组中至少一个元素返回一个真值，则返回 true。否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"some_2":{"name":"### some(predicate, thisArg?)","description":"some() 方法测试数组中是否至少有一个元素通过了由提供的函数实现的测试。如果在数组中找到一个元素使得提供的函数返回 true，则返回 true；否则返回 false。它不会修改数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示元素通过测试，否则返回一个假值。该函数被调用时将传入以下参数：
value:数组中当前正在处理的元素。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果回调函数对数组中至少一个元素返回一个真值，则返回 true。否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach":{"name":"### forEach(callbackfn, thisArg?)","description":"forEach() 方法对数组的每个元素执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T, index: number, array: Array\\) => void | 是 | - | - | 为数组中每个元素执行的函数。并会丢弃它的返回值。该函数被调用时将传入以下参数：
value:数组中正在处理的当前元素。
index:数组中正在处理的当前元素的索引。
array:调用了 forEach() 的数组本身。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach_1":{"name":"### forEach(callbackfn, thisArg?)","description":"forEach() 方法对数组的每个元素执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T, index: number) => void | 是 | - | - | 为数组中每个元素执行的函数。并会丢弃它的返回值。该函数被调用时将传入以下参数：
value:数组中正在处理的当前元素。
index:数组中正在处理的当前元素的索引。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach_2":{"name":"### forEach(callbackfn, thisArg?)","description":"forEach() 方法对数组的每个元素执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T) => void | 是 | - | - | 为数组中每个元素执行的函数。并会丢弃它的返回值。该函数被调用时将传入以下参数：
value:数组中正在处理的当前元素。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"map":{"name":"### map(callbackfn, thisArg?)","description":"map() 方法创建一个新数组，这个新数组由原数组中的每个元素都调用一次提供的函数后的返回值组成。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T, index: number, array: Array\\) => any | 是 | - | - | 为数组中的每个元素执行的函数。它的返回值作为一个元素被添加为新数组中。该函数被调用时将传入以下参数：
value:数组中当前正在处理的元素。
index:正在处理的元素在数组中的索引。
array:调用了 map() 的数组本身。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| U[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"map_1":{"name":"### map(callbackfn, thisArg?)","description":"map() 方法创建一个新数组，这个新数组由原数组中的每个元素都调用一次提供的函数后的返回值组成。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T, index: number) => any | 是 | - | - | 为数组中的每个元素执行的函数。它的返回值作为一个元素被添加为新数组中。该函数被调用时将传入以下参数：
value:数组中当前正在处理的元素。
index:正在处理的元素在数组中的索引。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| U[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"map_2":{"name":"### map(callbackfn, thisArg?)","description":"map() 方法创建一个新数组，这个新数组由原数组中的每个元素都调用一次提供的函数后的返回值组成。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T) => any | 是 | - | - | 为数组中的每个元素执行的函数。它的返回值作为一个元素被添加为新数组中。该函数被调用时将传入以下参数：
value:数组中当前正在处理的元素。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| U[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"filter":{"name":"### filter(predicate, thisArg?)","description":"filter() 方法创建给定数组一部分的浅拷贝，其包含通过所提供函数实现的测试的所有元素。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index?: number, array?: Array\\) => boolean | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以将元素保留在结果数组中，否则返回一个假值。该函数被调用时将传入以下参数：
value:数组中当前正在处理的元素。
index:正在处理的元素在数组中的索引。
array:调用了 filter() 的数组本身。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| S[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"filter_1":{"name":"### filter(predicate, thisArg?)","description":"filter() 方法创建给定数组一部分的浅拷贝，其包含通过所提供函数实现的测试的所有元素。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number, array: Array\\) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以将元素保留在结果数组中，否则返回一个假值。该函数被调用时将传入以下参数：
value:数组中当前正在处理的元素。
index:正在处理的元素在数组中的索引。
array:调用了 filter() 的数组本身。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"filter_2":{"name":"### filter(predicate, thisArg?)","description":"filter() 方法创建给定数组一部分的浅拷贝，其包含通过所提供函数实现的测试的所有元素。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以将元素保留在结果数组中，否则返回一个假值。该函数被调用时将传入以下参数：
value:数组中当前正在处理的元素。
index:正在处理的元素在数组中的索引。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"filter_3":{"name":"### filter(predicate, thisArg?)","description":"filter() 方法创建给定数组一部分的浅拷贝，其包含通过所提供函数实现的测试的所有元素。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以将元素保留在结果数组中，否则返回一个假值。该函数被调用时将传入以下参数：
value:数组中当前正在处理的元素。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T[\\] | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduce":{"name":"### reduce(callbackfn)","description":"reduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数，每一次运行 reducer 会将先前元素的计算结果作为参数传入，最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T, currentIndex: number, array: Array\\) => T | 是 | - | - | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数：
previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为 array\\[0] 的值。
currentValue:当前元素的值。在第一次调用时，如果指定了 initialValue，则为 array[0] 的值，否则为 array[1]
currentIndex:currentValue 在数组中的索引位置。在第一次调用时，如果指定了 initialValue 则为 0，否则为 1
array:调用了 reduce() 的数组本身。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduce_1":{"name":"### reduce(callbackfn)","description":"reduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数，每一次运行 reducer 会将先前元素的计算结果作为参数传入，最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T, currentIndex: number) => T | 是 | - | - | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数：
previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为 array\\[0] 的值。
currentValue:当前元素的值。在第一次调用时，如果指定了 initialValue，则为 array[0] 的值，否则为 array[1]
currentIndex:currentValue 在数组中的索引位置。在第一次调用时，如果指定了 initialValue 则为 0，否则为 1 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduce_2":{"name":"### reduce(callbackfn, initialValue)","description":"reduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数，每一次运行 reducer 会将先前元素的计算结果作为参数传入，最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T, currentIndex: number, array: Array\\) => T | 是 | - | - | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数：
previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为 array\\[0] 的值。
currentValue:当前元素的值。在第一次调用时，如果指定了 initialValue，则为 array[0] 的值，否则为 array[1]
currentIndex:currentValue 在数组中的索引位置。在第一次调用时，如果指定了 initialValue 则为 0，否则为 1
array:调用了 reduce() 的数组本身。 |\n| initialValue | T | 是 | - | - | 第一次调用回调时初始化 accumulator 的值。如果指定了 initialValue，则 callbackFn 从数组中的第一个值作为 currentValue 开始执行。如果没有指定 initialValue，则 accumulator 初始化为数组中的第一个值，并且 callbackFn 从数组中的第二个值作为 currentValue 开始执行。在这种情况下，如果数组为空（没有第一个值可以作为 accumulator 返回），则会抛出错误。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduce_3":{"name":"### reduce(callbackfn, initialValue)","description":"reduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数，每一次运行 reducer 会将先前元素的计算结果作为参数传入，最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T, currentIndex: number) => T | 是 | - | - | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数：
previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为 array\\[0] 的值。
currentValue:当前元素的值。在第一次调用时，如果指定了 initialValue，则为 array[0] 的值，否则为 array[1]
currentIndex:currentValue 在数组中的索引位置。在第一次调用时，如果指定了 initialValue 则为 0，否则为 1 |\n| initialValue | T | 是 | - | - | 第一次调用回调时初始化 accumulator 的值。如果指定了 initialValue，则 callbackFn 从数组中的第一个值作为 currentValue 开始执行。如果没有指定 initialValue，则 accumulator 初始化为数组中的第一个值，并且 callbackFn 从数组中的第二个值作为 currentValue 开始执行。在这种情况下，如果数组为空（没有第一个值可以作为 accumulator 返回），则会抛出错误。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduce_4":{"name":"### reduce(callbackfn, initialValue)","description":"reduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数，每一次运行 reducer 会将先前元素的计算结果作为参数传入，最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T) => T | 是 | - | - | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数：
previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为 array\\[0] 的值。
currentValue:当前元素的值。在第一次调用时，如果指定了 initialValue，则为 array[0] 的值，否则为 array[1] |\n| initialValue | T | 是 | - | - | 第一次调用回调时初始化 accumulator 的值。如果指定了 initialValue，则 callbackFn 从数组中的第一个值作为 currentValue 开始执行。如果没有指定 initialValue，则 accumulator 初始化为数组中的第一个值，并且 callbackFn 从数组中的第二个值作为 currentValue 开始执行。在这种情况下，如果数组为空（没有第一个值可以作为 accumulator 返回），则会抛出错误。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduce_5":{"name":"### reduce(callbackfn, initialValue)","description":"reduce() 方法对数组中的每个元素按序执行一个提供的 reducer 函数，每一次运行 reducer 会将先前元素的计算结果作为参数传入，最后将其结果汇总为单个返回值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: any, currentValue: T, currentIndex?: number, array?: Array\\) => any | 是 | - | - | 为数组中每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将作为 reduce() 的返回值。该函数被调用时将传入以下参数：
previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为 array\\[0] 的值。
currentValue:当前元素的值。在第一次调用时，如果指定了 initialValue，则为 array[0] 的值，否则为 array[1]
currentIndex:currentValue 在数组中的索引位置。在第一次调用时，如果指定了 initialValue 则为 0，否则为 1
array:调用了 reduce() 的数组本身。 |\n| initialValue | U | 是 | - | - | 第一次调用回调时初始化 accumulator 的值。如果指定了 initialValue，则 callbackFn 从数组中的第一个值作为 currentValue 开始执行。如果没有指定 initialValue，则 accumulator 初始化为数组中的第一个值，并且 callbackFn 从数组中的第二个值作为 currentValue 开始执行。在这种情况下，如果数组为空（没有第一个值可以作为 accumulator 返回），则会抛出错误。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| U | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"reduceRight":{"name":"### reduceRight(callbackfn)","description":"reduceRight() 方法对累加器（accumulator）和数组的每个值（按从右到左的顺序）应用一个函数，并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T, currentIndex: number, array: Array\\) => T | 是 | - | - | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数：
previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为数组最后一个元素的值。
currentValue:数组中当前正在处理的元素。
currentIndex:正在处理的元素在数组中的索引。
array:调用了 reduceRight() 的数组本身。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduceRight_1":{"name":"### reduceRight(callbackfn)","description":"reduceRight() 方法对累加器（accumulator）和数组的每个值（按从右到左的顺序）应用一个函数，并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T, currentIndex: number) => T | 是 | - | - | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数：
previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为数组最后一个元素的值。
currentValue:数组中当前正在处理的元素。
currentIndex:正在处理的元素在数组中的索引。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduceRight_2":{"name":"### reduceRight(callbackfn)","description":"reduceRight() 方法对累加器（accumulator）和数组的每个值（按从右到左的顺序）应用一个函数，并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T) => T | 是 | - | - | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数：
previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为数组最后一个元素的值。
currentValue:数组中当前正在处理的元素。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduceRight_3":{"name":"### reduceRight(callbackfn, initialValue)","description":"reduceRight() 方法对累加器（accumulator）和数组的每个值（按从右到左的顺序）应用一个函数，并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T, currentIndex: number, array: Array\\) => T | 是 | - | - | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数：
previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为数组最后一个元素的值。
currentValue:数组中当前正在处理的元素。
currentIndex:正在处理的元素在数组中的索引。
array:调用了 reduceRight() 的数组本身。 |\n| initialValue | T | 是 | - | - | 首次调用 callbackFn 时累加器的值。如果不提供初始值，则将使用数组中的最后一个元素，并在迭代时跳过它。没有初始值的情况下，在空数组上调用 reduceRight() 会产生 TypeError。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduceRight_4":{"name":"### reduceRight(callbackfn, initialValue)","description":"reduceRight() 方法对累加器（accumulator）和数组的每个值（按从右到左的顺序）应用一个函数，并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T, currentIndex: number) => T | 是 | - | - | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数：
previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为数组最后一个元素的值。
currentValue:数组中当前正在处理的元素。
currentIndex:正在处理的元素在数组中的索引。 |\n| initialValue | T | 是 | - | - | 首次调用 callbackFn 时累加器的值。如果不提供初始值，则将使用数组中的最后一个元素，并在迭代时跳过它。没有初始值的情况下，在空数组上调用 reduceRight() 会产生 TypeError。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduceRight_5":{"name":"### reduceRight(callbackfn, initialValue)","description":"reduceRight() 方法对累加器（accumulator）和数组的每个值（按从右到左的顺序）应用一个函数，并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: T, currentValue: T) => T | 是 | - | - | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数：
previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为数组最后一个元素的值。
currentValue:数组中当前正在处理的元素。 |\n| initialValue | T | 是 | - | - | 首次调用 callbackFn 时累加器的值。如果不提供初始值，则将使用数组中的最后一个元素，并在迭代时跳过它。没有初始值的情况下，在空数组上调用 reduceRight() 会产生 TypeError。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| T | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"reduceRight_6":{"name":"### reduceRight(callbackfn, initialValue)","description":"reduceRight() 方法对累加器（accumulator）和数组的每个值（按从右到左的顺序）应用一个函数，并使其成为单个值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (previousValue: any, currentValue: T, currentIndex?: number, array?: Array\\) => any | 是 | - | - | 为数组中的每个元素执行的函数。其返回值将作为下一次调用 callbackFn 时的 accumulator 参数。对于最后一次调用，返回值将成为 reduceRight() 的返回值。该函数被调用时将传入以下参数：
previousValue:上一次调用 callbackFn 的结果。在第一次调用时，如果指定了 initialValue 则为指定的值，否则为数组最后一个元素的值。
currentValue:数组中当前正在处理的元素。
index:正在处理的元素在数组中的索引。
array:调用了 reduceRight() 的数组本身。 |\n| initialValue | U | 是 | - | - | 首次调用 callbackFn 时累加器的值。如果不提供初始值，则将使用数组中的最后一个元素，并在迭代时跳过它。没有初始值的情况下，在空数组上调用 reduceRight() 会产生 TypeError。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| U | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"find":{"name":"### find(predicate, thisArg?)","description":"find() 方法返回数组中满足提供的测试函数的第一个元素的值。否则返回 null。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number, obj: Array\\) => boolean | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值来表示已经找到了匹配的元素。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| S \\| null | 数组中第一个满足所提供测试函数的元素的值，否则返回 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"find_1":{"name":"### find(predicate, thisArg?)","description":"find() 方法返回数组中满足提供的测试函数的第一个元素的值。否则返回 null。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number) => boolean | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值来表示已经找到了匹配的元素。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| S \\| null | 数组中第一个满足所提供测试函数的元素的值，否则返回 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"find_2":{"name":"### find(predicate, thisArg?)","description":"find() 方法返回数组中满足提供的测试函数的第一个元素的值。否则返回 null。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T) => boolean | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值来表示已经找到了匹配的元素。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| S \\| null | 数组中第一个满足所提供测试函数的元素的值，否则返回 null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"findIndex":{"name":"### findIndex(predicate, thisArg?)","description":"findIndex() 方法返回数组中满足提供的测试函数的第一个元素的索引。若没有找到对应元素则返回 -1。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number, obj: Array\\) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示已找到匹配元素，否则返回一个假值。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 数组中第一个满足测试条件的元素的索引。否则返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"findIndex_1":{"name":"### findIndex(predicate, thisArg?)","description":"findIndex() 方法返回数组中满足提供的测试函数的第一个元素的索引。若没有找到对应元素则返回 -1。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T, index: number) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示已找到匹配元素，否则返回一个假值。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 数组中第一个满足测试条件的元素的索引。否则返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"findIndex_2":{"name":"### findIndex(predicate, thisArg?)","description":"findIndex() 方法返回数组中满足提供的测试函数的第一个元素的索引。若没有找到对应元素则返回 -1。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| predicate | (value: T) => any | 是 | - | - | 为数组中的每个元素执行的函数。它应该返回一个真值以指示已找到匹配元素，否则返回一个假值。 |\n| thisArg | any | 否 | - | - | 执行 callbackFn 时用作 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 数组中第一个满足测试条件的元素的索引。否则返回 -1。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"fill":{"name":"### fill(value, start?, end?)","description":"fill() 方法用一个固定值填充一个数组中从起始索引（默认为 0）到终止索引（默认为 array.length）内的全部元素。它返回修改后的数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | T | 是 | - | - | 用来填充数组元素的值。注意所有数组中的元素都将是这个确定的值：如果 value 是个对象，那么数组的每一项都会引用这个元素。 |\n| start | number | 是 | - | - | 基于零的索引，从此开始填充，转换为整数。 |\n| end | number | 是 | - | - | 基于零的索引，在此结束填充，转换为整数。fill() 填充到但不包含 end 索引。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| this | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"copyWithin":{"name":"### copyWithin(target, start?, end?)","description":"copyWithin() 方法浅复制数组的一部分到同一数组中的另一个位置，并返回它，不会改变原数组的长度。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| target | number | 是 | - | - | 序列开始替换的目标位置，以 0 为起始的下标表示，且将被转换为整数 |\n| start | number | 是 | - | - | 要复制的元素序列的起始位置，以 0 为起始的下标表示，且将被转换为整数 |\n| end | number | 是 | - | - | 要复制的元素序列的结束位置，以 0 为起始的下标表示，且将被转换为整数。copyWithin 将会拷贝到该位置，但不包括 end 这个位置的元素。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| this | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"includes":{"name":"### includes(searchElement, fromIndex?)","description":"includes() 方法用来判断一个数组是否包含一个指定的值，根据情况，如果包含则返回 true，否则返回 false。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| searchElement | any | 是 | - | - | 需要查找的值。 |\n| fromIndex | number | 是 | - | - | 可选。开始搜索的索引（从零开始），会转换为整数。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 一个布尔值，如果在数组中（或者在 fromIndex 所指示的数组部分中，如果指定 fromIndex 的话）找到 searchElement 值，则该值为 true。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"isArray":{"name":"### isArray(arg)","description":"Array.isArray() 静态方法用于确定传递的值是否是一个 Array。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | any | 是 | - | - | 需要检测的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| arg is any[\\] | 如果 value 是 Array，则为 true；否则为 false。如果 value 是 TypedArray 实例，则总是返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"}},"Map":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Map)","size":{"name":"### size","description":"","param":"","returnValue":"**返回值** \n\nMap 对象的成员数量。","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"clear":{"name":"### clear()","description":"移除 Map 对象中的所有元素。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"delete":{"name":"### delete(key)","description":"用于移除 Map 对象中指定的元素。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | K | 是 | - | - | 要从 Map 对象中删除的元素的键。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果 Map 对象中的元素存在并已被移除，则为 true；如果该元素不存在，则为 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach":{"name":"### forEach(callbackfn, thisArg?)","description":"按照插入顺序依次对 Map 中每个键/值对执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: any, key: any, map: [Map\\](#map-values)) => void | 是 | - | - | Map 中每个元素所要执行的函数。它具有如下的参数：
value: 每个迭代的值。
key: 每个迭代的键。
map: 正在迭代的 Map。 |\n| thisArg | any | 否 | - | - | 在 callbackfn 执行中使用的 this 的值。 | \n\n##### Map\\ 的属性值 @map-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| size | number | 是 | - | | |\n\n##### Map\\ 的方法 @map-values \n\n##### clear() @clear\n移除 Map 对象中的所有元素。\n\n\n###### clear 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/map.html#clear)\n\n##### delete(key) @delete\n用于移除 Map 对象中指定的元素。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | any | 是 | - | - | 要从 Map 对象中删除的元素的键。 | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n###### delete 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/map.html#delete)\n\n##### forEach(callbackfn, thisArg?) @foreach\n按照插入顺序依次对 Map 中每个键/值对执行一次给定的函数。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: any, key: any, map: [Map\\](#map-values)) => void | 是 | - | - | Map 中每个元素所要执行的函数。它具有如下的参数：
value: 每个迭代的值。
key: 每个迭代的键。
map: 正在迭代的 Map。 |\n| thisArg | any | 否 | - | - | 在 callbackfn 执行中使用的 this 的值。 | \n\n\n###### forEach 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/map.html#forEach)\n\n##### get(key) @get\n从 Map 对象返回指定的元素。如果与所提供的键相关联的值是一个对象，那么你将获得该对象的引用，对该对象所做的任何更改都会有效地在 Map 对象中修改它。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | any | 是 | - | - | 从 Map 对象返回的元素的键。 | \n\n###### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| any \\| null | 否 |\n \n\n###### get 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/map.html#get)\n\n##### has(key) @has\n返回一个布尔值，指示具有指定键的元素是否存在。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | any | 是 | - | - | 用于测试 Map 对象中是否存在的元素的键。 | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n###### has 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/map.html#has)\n\n##### set(key, value) @set\n为 Map 对象添加或更新一个指定了键（key）和值（value）的（新）键值对。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | any | 是 | - | - | 要添加到 Map 对象的元素的键。该值可以是任何数据类型（任何原始值或任何类型的对象）。 |\n| value | any | 是 | - | - | 要添加到 Map 对象的元素的值。该值可以是任何数据类型（任何原始值或任何类型的对象）。 | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n###### set 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/map.html#set)\n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach_1":{"name":"### forEach(callbackfn, thisArg?)","description":"按照插入顺序依次对 Map 中每个键/值对执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: any, key: any) => void | 是 | - | - | Map 中每个元素所要执行的函数。它具有如下的参数：
value: 每个迭代的值。
key: 每个迭代的键。 |\n| thisArg | any | 否 | - | - | 在 callbackfn 执行中使用的 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach_2":{"name":"### forEach(callbackfn, thisArg?)","description":"按照插入顺序依次对 Map 中每个键/值对执行一次给定的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: any) => void | 是 | - | - | Map 中每个元素所要执行的函数。它具有如下的参数：
value: 每个迭代的值。 |\n| thisArg | any | 否 | - | - | 在 callbackfn 执行中使用的 this 的值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"get":{"name":"### get(key)","description":"从 Map 对象返回指定的元素。如果与所提供的键相关联的值是一个对象，那么你将获得该对象的引用，对该对象所做的任何更改都会有效地在 Map 对象中修改它。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | K | 是 | - | - | 从 Map 对象返回的元素的键。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| V \\| null | 与指定键相关联的元素，如果键在 Map 对象中找不到，则返回 null。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"has":{"name":"### has(key)","description":"返回一个布尔值，指示具有指定键的元素是否存在。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | K | 是 | - | - | 用于测试 Map 对象中是否存在的元素的键。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果 Map 对象中存在具有指定键的元素，则返回 true；否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"set":{"name":"### set(key, value)","description":"为 Map 对象添加或更新一个指定了键（key）和值（value）的（新）键值对。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | K | 是 | - | - | 要添加到 Map 对象的元素的键。该值可以是任何数据类型（任何原始值或任何类型的对象）。 |\n| value | V | 是 | - | - | 要添加到 Map 对象的元素的值。该值可以是任何数据类型（任何原始值或任何类型的对象）。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| this | Map 对象 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"}},"Set":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Set)","size":{"name":"### size","description":"返回 Set 对象中（唯一的）元素的个数。","param":"","returnValue":"**返回值** \n\n返回 Set 对象中（唯一的）元素的个数。","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"prop"},"add":{"name":"### add(value)","description":"如果 Set 对象中没有具有相同值的元素，则 add() 方法将插入一个具有指定值的新元素到 Set 对象中。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | T | 是 | - | - | 要添加到 Set 对象的元素的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| this | Set 对象本身。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"clear":{"name":"### clear()","description":"移除 Set 对象中所有元素。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"delete":{"name":"### delete(value)","description":"从 Set 对象中删除指定的值（如果该值在 Set 中）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | T | 是 | - | - | 要从 Set 中移除的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 成功删除返回 true，否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach":{"name":"### forEach(callbackfn, thisArg?)","description":"对 Set 对象中的每个值按插入顺序执行一次提供的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T, value2: T, set: [Set\\](#set-values)) => void | 是 | - | - | 为集合中每个元素执行的回调函数，该函数接收三个参数：value、key: Set 中正在处理的当前元素。因为 Set 中没有键，所以 value 会被共同传递给这两个参数。set: 调用 forEach() 的 Set 对象。 |\n| thisArg | any | 否 | - | - | 值在执行 callbackFn 时作为 this 使用。 | \n\n##### Set\\ 的属性值 @set-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| size | number | 是 | - | | 返回 Set 对象中（唯一的）元素的个数。 |\n\n##### Set\\ 的方法 @set-values \n\n##### add(value) @add\n如果 Set 对象中没有具有相同值的元素，则 add() 方法将插入一个具有指定值的新元素到 Set 对象中。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | T | 是 | - | - | 要添加到 Set 对象的元素的值。 | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n###### add 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/Set.html#add)\n\n##### clear() @clear\n移除 Set 对象中所有元素。\n\n\n###### clear 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/Set.html#clear)\n\n##### delete(value) @delete\n从 Set 对象中删除指定的值（如果该值在 Set 中）。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | T | 是 | - | - | 要从 Set 中移除的值。 | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n###### delete 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/Set.html#delete)\n\n##### forEach(callbackfn, thisArg?) @foreach\n对 Set 对象中的每个值按插入顺序执行一次提供的函数。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T, value2: T, set: [Set\\](#set-values)) => void | 是 | - | - | 为集合中每个元素执行的回调函数，该函数接收三个参数：value、key: Set 中正在处理的当前元素。因为 Set 中没有键，所以 value 会被共同传递给这两个参数。set: 调用 forEach() 的 Set 对象。 |\n| thisArg | any | 否 | - | - | 值在执行 callbackFn 时作为 this 使用。 | \n\n\n###### forEach 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/Set.html#forEach)\n\n##### has(value) @has\n返回一个布尔值来指示对应的值是否存在于 Set 对象中。\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | T | 是 | - | - | 要测试是否存在于 Set 对象中的值。 | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n###### has 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n\n\n###### 参见\n- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/uts/buildin-object-api/Set.html#has)\n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach_1":{"name":"### forEach(callbackfn, thisArg?)","description":"对 Set 对象中的每个值按插入顺序执行一次提供的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T, value2: T) => void | 是 | - | - | 为集合中每个元素执行的回调函数，该函数接收两个参数：value、key。 |\n| thisArg | any | 否 | - | - | 值在执行 callbackFn 时作为 this 使用。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"forEach_2":{"name":"### forEach(callbackfn, thisArg?)","description":"对 Set 对象中的每个值按插入顺序执行一次提供的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackfn | (value: T) => void | 是 | - | - | 为集合中每个元素执行的回调函数，该函数接收一个参数：value。 |\n| thisArg | any | 否 | - | - | 值在执行 callbackFn 时作为 this 使用。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"has":{"name":"### has(value)","description":"返回一个布尔值来指示对应的值是否存在于 Set 对象中。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | T | 是 | - | - | 要测试是否存在于 Set 对象中的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果 Set 对象中存在具有指定值的元素，则返回 true；否则返回 false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"}},"Promise":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Promise)","Constructor":{"name":"### Constructor(fn)","description":"创建一个新的 Promise 对象。该构造函数主要用于封装还没有添加 promise 支持的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| fn | (resolve: (value: T) => void, reject: (reason?: any \\| null) => void) => void | 是 | - | - | 在构造函数中执行的 function。 | \n","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"Constructor_1":{"name":"### Constructor(fn)","description":"创建一个新的 Promise 对象。该构造函数主要用于封装还没有添加 promise 支持的函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| fn | (resolve: (value: T) => void) => void | 是 | - | - | 在构造函数中执行的 function。 | \n","returnValue":"","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"then":{"name":"### then()","description":"将一个兑现处理器和拒绝处理器附加到 Promise 上，并返回一个新的 Promise，解决为调用处理器得到的返回值，或者如果 Promise 没有被处理（即相关处理器 onFulfilled 或 onRejected 不是函数），则以原始敲定值解决。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"then_1":{"name":"### then(onFulfilled, onRejected?)","description":"将一个兑现处理器和拒绝处理器附加到 Promise 上，并返回一个新的 Promise，解决为调用处理器得到的返回值，或者如果 Promise 没有被处理（即相关处理器 onFulfilled 或 onRejected 不是函数），则以原始敲定值解决。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| onFulfilled | () => any | 是 | - | - | 一个在此 Promise 对象被兑现时异步执行的函数。它的返回值将成为 then() 返回的 Promise 对象的兑现值。 |\n| onRejected | (...args?: any) => any \\| null | 否 | - | - | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"then_2":{"name":"### then(onFulfilled, onRejected?)","description":"将一个兑现处理器和拒绝处理器附加到 Promise 上，并返回一个新的 Promise，解决为调用处理器得到的返回值，或者如果 Promise 没有被处理（即相关处理器 onFulfilled 或 onRejected 不是函数），则以原始敲定值解决。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| onFulfilled | () => Promise\\ | 是 | - | - | 一个在此 Promise 对象被兑现时异步执行的函数。它的返回值将成为 then() 返回的 Promise 对象的兑现值。 |\n| onRejected | (...args?: any) => any \\| null | 否 | - | - | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"then_3":{"name":"### then(onFulfilled, onRejected?)","description":"将一个兑现处理器和拒绝处理器附加到 Promise 上，并返回一个新的 Promise，解决为调用处理器得到的返回值，或者如果 Promise 没有被处理（即相关处理器 onFulfilled 或 onRejected 不是函数），则以原始敲定值解决。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| onFulfilled | (res: T) => any | 是 | - | - | 一个在此 Promise 对象被兑现时异步执行的函数。它的返回值将成为 then() 返回的 Promise 对象的兑现值。 |\n| onRejected | (...args?: any) => any \\| null | 否 | - | - | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"then_4":{"name":"### then(onFulfilled, onRejected?)","description":"将一个兑现处理器和拒绝处理器附加到 Promise 上，并返回一个新的 Promise，解决为调用处理器得到的返回值，或者如果 Promise 没有被处理（即相关处理器 onFulfilled 或 onRejected 不是函数），则以原始敲定值解决。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| onFulfilled | (res: T) => Promise\\ | 是 | - | - | 一个在此 Promise 对象被兑现时异步执行的函数。它的返回值将成为 then() 返回的 Promise 对象的兑现值。 |\n| onRejected | (...args?: any) => any \\| null | 否 | - | - | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"catch":{"name":"### catch()","description":"将一个拒绝处理回调函数附加到 Promise 上，并返回一个新的 Promise，如果回调被调用，则解决为回调的返回值，如果 Promise 被兑现，解决为其原始兑现值。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"catch_1":{"name":"### catch(onRejected)","description":"将一个拒绝处理回调函数附加到 Promise 上，并返回一个新的 Promise，如果回调被调用，则解决为回调的返回值，如果 Promise 被兑现，解决为其原始兑现值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| onRejected | () => any | 是 | - | - | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"catch_2":{"name":"### catch(onRejected)","description":"将一个拒绝处理回调函数附加到 Promise 上，并返回一个新的 Promise，如果回调被调用，则解决为回调的返回值，如果 Promise 被兑现，解决为其原始兑现值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| onRejected | () => Promise\\ | 是 | - | - | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"catch_3":{"name":"### catch(onRejected)","description":"将一个拒绝处理回调函数附加到 Promise 上，并返回一个新的 Promise，如果回调被调用，则解决为回调的返回值，如果 Promise 被兑现，解决为其原始兑现值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| onRejected | (res?: any \\| null) => any | 是 | - | - | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"catch_4":{"name":"### catch(onRejected)","description":"将一个拒绝处理回调函数附加到 Promise 上，并返回一个新的 Promise，如果回调被调用，则解决为回调的返回值，如果 Promise 被兑现，解决为其原始兑现值。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| onRejected | (res?: any \\| null) => Promise\\ | 是 | - | - | 一个在此 Promise 对象被拒绝时异步执行的函数。它的返回值将成为 catch() 返回的 Promise 对象的兑现值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"finally":{"name":"### finally()","description":"将一个处理器附加到 Promise 上，并返回一个新的 Promise，当原始 Promise 被解决时解决。无论 Promise 是否被兑现还是被拒绝，处理器都会在 Promise 敲定时被调用。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| | (...args?: any) => any | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"resolve":{"name":"### resolve()","description":"返回一个新的 Promise 对象，该对象以给定的值兑现。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"resolve_1":{"name":"### resolve(value)","description":"返回一个新的 Promise 对象，该对象以给定的值兑现。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | T \\| null | 否 | - | - | 一个兑现的值。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"resolve_2":{"name":"### resolve(value)","description":"返回一个新的 Promise 对象，该对象以给定的值兑现。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | Promise\\ \\| null | 否 | - | - | 一个 Promise。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"reject":{"name":"### reject(value?)","description":"返回一个新的 Promise 对象，该对象以给定的原因拒绝。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | any \\| null | 否 | - | - | 一个拒绝的原因。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"all":{"name":"### all(arr)","description":"接受一个 Promise 可迭代对象作为输入，并返回单个 Promise。返回的 Promise 在所有输入的 Promise 都兑现时（包括传入的可迭代对象为空时）被兑现，其值为一个包含所有兑现值的数组。如果输入的任何 Promise 被拒绝，返回的 Promise 也会被拒绝，并返回第一个拒绝的原因。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arr | Array\\\\> | 是 | - | - | 一个 Promise 数组。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\> | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"race":{"name":"### race(arr)","description":"接受一个 Promise 可迭代对象作为输入，并返回单个 Promise。返回的 Promise 与第一个敲定的 Promise 的最终状态保持一致。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arr | Array\\\\> | 是 | - | - | 一个 Promise 数组。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"any":{"name":"### any(arr)","description":"接受一个 Promise 可迭代对象作为输入，并返回单个 Promise。返回的 Promise 在任何输入的 Promise 兑现时兑现，其值为第一个兑现的值。如果所有输入的 Promise 都被拒绝（包括传入的可迭代对象为空时），返回的 Promise 将以带有一个包含拒绝原因的数组的 AggregateError 拒绝。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arr | Array\\\\> | 是 | - | - | 一个 Promise 数组。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\ | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"},"allSettled":{"name":"### allSettled(arr)","description":"接受一个 Promise 可迭代对象作为输入，并返回单个 Promise。返回的 Promise 在所有输入的 Promise 都敲定时兑现（包括传入的可迭代对象为空时），其值为一个描述每个 Promise 结果的对象数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arr | Array\\\\> | 是 | - | - | 一个 Promise 数组。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| Promise\\>> | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | 4.0 | √ | x | √ |\n","itemType":"method"}},"UTSJSONObject":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.UTSJSONObject)","get":{"name":"### get(key)","description":"获取一个 属性，返回类型是any 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| any\\|null | 如果属性存在返回结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"set":{"name":"### set(key, value)","description":"获取一个 属性，返回类型是any 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - |\n| value | any | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| void | 如果属性存在返回结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"getAny":{"name":"### getAny(key)","description":"获取一个 属性，返回类型是any 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| any\\|null | 如果属性存在返回结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"getBoolean":{"name":"### getBoolean(key)","description":"获取一个Boolean属性，返回类型是Boolean 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean\\|null | 如果属性名存在，且类型为Boolean返回对应的结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"getNumber":{"name":"### getNumber(key)","description":"获取一个number属性，返回类型是number 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number\\|null | 如果属性名存在，且类型为number返回对应的结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"getString":{"name":"### getString(key)","description":"获取一个string属性，返回类型是string 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string\\|null | 如果属性名存在，且类型为string返回对应的结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"getJSON":{"name":"### getJSON(key)","description":"获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UTSJSONObject\\|null | 如果属性名存在，且类型为UTSJSONObject返回对应的结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"getArray":{"name":"### getArray(key)","description":"获取一个Array属性，返回类型是Array 或者 null, 数组元素类型由泛型T决定","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Array\\\\|null | 如果属性名存在，且类型为Array返回对应的结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"getArray_1":{"name":"### getArray(key)","description":"获取一个Array属性，返回类型是Array 或者 null","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| key | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Array\\\\|null | 如果属性名存在，且类型为Array返回对应的结果，不存在返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"},"toMap":{"name":"### toMap()","description":"将当前 UTSJSONObject 实例转换为 Map 实例。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Map\\ | 返回 Map\\ 类型的 map | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | √ | x |\n","itemType":"method"}},"Console":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.buildInObject.Console)","assert":{"name":"### assert(condition?, ...data)","description":"如果断言为 false，则将一个错误消息写入控制台。如果断言是 true，没有任何反应。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| condition | boolean | 是 | - | - | - |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"clear":{"name":"### clear()","description":"console.clear() 方法清空控制台，但前提是该控制台允许清空。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"count":{"name":"### count(label?)","description":"console.count() 方法会记录调用 count() 的次数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| label | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"countReset":{"name":"### countReset(label?)","description":"重置计数器。此函数有一个可选参数 label。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| label | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"debug":{"name":"### debug(...data)","description":"在控制台打印 debug 日志","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"dir":{"name":"### dir(item?, options?)","description":"console.dir() 方法可以显示指定 JavaScript 对象的属性列表，并以交互式的形式展现。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| item | any \\| null | 否 | - | - | |\n| options | any \\| null | 否 | - | - | | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"dirxml":{"name":"### dirxml(...data)","description":"显示一个明确的 XML/HTML 元素的包括所有后代元素的交互树。
非标准: 该特性是非标准的，请尽量不要在生产环境中使用它！","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"error":{"name":"### error(...data)","description":"在控制台打印 error 日志","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"group":{"name":"### group(...data)","description":"console.group() 方法在控制台上创建一个新的分组。随后输出到控制台上的内容都会被添加一个缩进，表示该内容属于当前分组，直到调用 console.groupEnd() 之后，当前分组结束。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"groupCollapsed":{"name":"### groupCollapsed(...data)","description":"console.groupCollapsed() 方法在控制台上创建一个新的分组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"groupEnd":{"name":"### groupEnd()","description":"在控制台中退出一格缩进 (结束分组).","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"info":{"name":"### info(...data)","description":"在控制台打印 info 日志","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"log":{"name":"### log(...data)","description":"在控制台打印 log 日志","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"},"table":{"name":"### table(tabularData?, properties?)","description":"将数据以表格的形式显示。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| tabularData | any \\| null | 否 | - | - | |\n| properties | string[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"time":{"name":"### time(label?)","description":"你可以启动一个计时器来跟踪某一个操作的占用时长。每一个计时器必须拥有唯一的名字，页面中最多能同时运行 10,000 个计时器。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| label | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"timeEnd":{"name":"### timeEnd(label?)","description":"停止一个通过 console.time() 启动的计时器
非标准: 该特性是非标准的，请尽量不要在生产环境中使用它！","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| label | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"timeLog":{"name":"### timeLog(label?, ...data)","description":"在控制台输出计时器的值，该计时器必须已经通过 console.time() 启动。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| label | string | 是 | - | - | - |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"timeStamp":{"name":"### timeStamp(label?)","description":"非标准: 该特性是非标准的，请尽量不要在生产环境中使用它！","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| label | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"trace":{"name":"### trace(...data)","description":"向控制台 输出一个堆栈跟踪。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method"},"warn":{"name":"### warn(...data)","description":"在控制台打印 warn 日志","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | (any \\| null)[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | √ | √ | √ |\n","itemType":"method"}},"Global":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods)","eval":{"name":"### eval(x)","description":"eval() 函数会将传入的字符串当做 JavaScript 代码进行执行。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | string | 是 | - | - | 一个表示 JavaScript 表达式、语句或一系列语句的字符串。表达式可以包含变量与已存在对象的属性。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| any | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.eval)"},"parseInt":{"name":"### parseInt(string, radix?)","description":"parseInt(string, radix) 解析一个字符串并返回指定基数的十进制整数，radix 是 2-36 之间的整数，表示被解析字符串的基数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| string | string | 是 | - | - | 要被解析的值。字符串开头的空白符将会被忽略。（注意：只接收字符串类型的参数，其他类型将编译报错。） |\n| radix | number | 是 | - | - | 从 2 到 36 的整数，表示进制的基数。例如指定 16 表示被解析值是十六进制数。如果超出这个范围，将返回 NaN。假如指定 0 或未指定，基数将会根据字符串的值进行推算。注意，推算的结果不会永远是默认值 10！ | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 从给定的字符串中解析出的一个整数，或者 NaN。当radix 小于 2 或大于 36，或第一个非空格字符不能转换为数字时返回 NAN。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.parseInt)"},"parseFloat":{"name":"### parseFloat(string)","description":"parseFloat() 函数解析一个参数（直接收字符串类型的参数，其他类型编译报错）并返回一个浮点数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| string | string | 是 | - | - | 需要被解析成为浮点数的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 给定值被解析成浮点数。如果给定值不能被转换成数值，则会返回 NaN。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.parseFloat)"},"isNaN":{"name":"### isNaN(number)","description":"isNaN() 函数用来确定一个值是否为NaN 。注：isNaN函数内包含一些非常有趣的规则；你也可以使用 ECMAScript 2015 中定义的 Number.isNaN() 来判断。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| number | number | 是 | - | - | 要被检测的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果给定值为 NaN则返回值为true；否则为false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.isNaN)"},"isFinite":{"name":"### isFinite(number)","description":"isFinite() 函数用来判断被传入的参数值是否为一个有限数值（finite number）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| number | number | 是 | - | - | 要被检测的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果参数是 NaN，正无穷大或者负无穷大，会返回false，其他返回 true。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.isFinite)"},"decodeURI":{"name":"### decodeURI(encodedURI)","description":"decodeURI() 函数能解码由encodeURI 创建或其他流程得到的统一资源标识符（URI）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| encodedURI | string | 是 | - | - | 一个完整的编码过的 URI | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个给定编码统一资源标识符 (URI) 的未编码版本的新字符串, 当 encodedURI 包含无效字符序列时，会返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.91 | 4.11 | 4.0 | 3.91 | 3.91 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.decodeURI)"},"decodeURIComponent":{"name":"### decodeURIComponent(encodedURIComponent)","description":"decodeURIComponent() 方法用于解码由 encodeURIComponent 方法或者其他类似方法编码的部分统一资源标识符（URI）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| encodedURIComponent | string | 是 | - | - | 编码后的部分 URI | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个解码后的统一资源标识符（URI）字符串，处理前的 URI 经过了给定格式的编码。当 encodedURI 包含无效字符序列时，会返回null. | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.91 | 4.11 | 4.0 | 3.91 | 3.91 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.decodeURIComponent)"},"encodeURI":{"name":"### encodeURI(uri)","description":"encodeURI() 函数通过将特定字符的每个实例替换为一个、两个、三或四转义序列来对统一资源标识符 (URI) 进行编码 (该字符的 UTF-8 编码仅为四转义序列) 由两个 \"代理\" 字符组成)。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| uri | string | 是 | - | - | 一个完整的 URI。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个新字符串，表示提供的字符串编码为统一资源标识符 (URI)。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.91 | 4.11 | 4.0 | 3.91 | 3.91 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.encodeURI)"},"encodeURIComponent":{"name":"### encodeURIComponent(uriComponent)","description":"encodeURIComponent() 函数通过将特定字符的每个实例替换成代表字符的 UTF-8 编码的一个、两个、三个或四个转义序列来编码 URI（只有由两个“代理”字符组成的字符会被编码为四个转义序列）。与 encodeURI() 相比，此函数会编码更多的字符，包括 URI 语法的一部分。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| uriComponent | string | 是 | - | - | 要被检测的 string 值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 原字串作为 URI 组成部分被被编码后的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.91 | 4.11 | 4.0 | 3.91 | 3.91 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.encodeURIComponent)"},"setInterval":{"name":"### setInterval(handler, timeout?, ...arguments)","description":"setInterval() 方法重复调用一个函数或执行一个代码片段，在每次调用之间具有固定的时间间隔。
它返回一个 interval ID，该 ID 唯一地标识时间间隔，因此你可以稍后通过调用 clearInterval() 来移除定时器。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| handler | string \\| Function | 是 | - | - | - |\n| timeout | number | 是 | - | - | - |\n| arguments | any[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9 | 3.9 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.setInterval)"},"setTimeout":{"name":"### setTimeout(handler, timeout?, ...arguments)","description":"全局的 setTimeout() 方法设置一个定时器，一旦定时器到期，就会执行一个函数或指定的代码片段。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| handler | string \\| Function | 是 | - | - | - |\n| timeout | number | 是 | - | - | - |\n| arguments | any[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9 | 3.9 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.setTimeout)"},"clearInterval":{"name":"### clearInterval(id)","description":"clearInterval() 方法可取消先前通过 setInterval() 设置的重复定时任务。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| id | number \\| undefined | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9 | 3.9 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.clearInterval)"},"clearTimeout":{"name":"### clearTimeout(id)","description":"clearTimeout() 方法取消了先前通过调用setTimeout()建立的定时器","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| id | number \\| undefined | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9 | 3.9 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.globleMethods.clearTimeout)"}},"Timers":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods)","eval":{"name":"### eval(x)","description":"eval() 函数会将传入的字符串当做 JavaScript 代码进行执行。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| x | string | 是 | - | - | 一个表示 JavaScript 表达式、语句或一系列语句的字符串。表达式可以包含变量与已存在对象的属性。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| any | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | x | 4.0 | x | x | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.eval)"},"parseInt":{"name":"### parseInt(string, radix?)","description":"parseInt(string, radix) 解析一个字符串并返回指定基数的十进制整数，radix 是 2-36 之间的整数，表示被解析字符串的基数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| string | string | 是 | - | - | 要被解析的值。字符串开头的空白符将会被忽略。（注意：只接收字符串类型的参数，其他类型将编译报错。） |\n| radix | number | 是 | - | - | 从 2 到 36 的整数，表示进制的基数。例如指定 16 表示被解析值是十六进制数。如果超出这个范围，将返回 NaN。假如指定 0 或未指定，基数将会根据字符串的值进行推算。注意，推算的结果不会永远是默认值 10！ | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 从给定的字符串中解析出的一个整数，或者 NaN。当radix 小于 2 或大于 36，或第一个非空格字符不能转换为数字时返回 NAN。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.parseInt)"},"parseFloat":{"name":"### parseFloat(string)","description":"parseFloat() 函数解析一个参数（直接收字符串类型的参数，其他类型编译报错）并返回一个浮点数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| string | string | 是 | - | - | 需要被解析成为浮点数的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 给定值被解析成浮点数。如果给定值不能被转换成数值，则会返回 NaN。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.parseFloat)"},"isNaN":{"name":"### isNaN(number)","description":"isNaN() 函数用来确定一个值是否为NaN 。注：isNaN函数内包含一些非常有趣的规则；你也可以使用 ECMAScript 2015 中定义的 Number.isNaN() 来判断。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| number | number | 是 | - | - | 要被检测的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果给定值为 NaN则返回值为true；否则为false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.isNaN)"},"isFinite":{"name":"### isFinite(number)","description":"isFinite() 函数用来判断被传入的参数值是否为一个有限数值（finite number）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| number | number | 是 | - | - | 要被检测的值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果参数是 NaN，正无穷大或者负无穷大，会返回false，其他返回 true。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9+ | 3.9+ | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.isFinite)"},"decodeURI":{"name":"### decodeURI(encodedURI)","description":"decodeURI() 函数能解码由encodeURI 创建或其他流程得到的统一资源标识符（URI）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| encodedURI | string | 是 | - | - | 一个完整的编码过的 URI | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 返回一个给定编码统一资源标识符 (URI) 的未编码版本的新字符串, 当 encodedURI 包含无效字符序列时，会返回null | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.91 | 4.11 | 4.0 | 3.91 | 3.91 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.decodeURI)"},"decodeURIComponent":{"name":"### decodeURIComponent(encodedURIComponent)","description":"decodeURIComponent() 方法用于解码由 encodeURIComponent 方法或者其他类似方法编码的部分统一资源标识符（URI）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| encodedURIComponent | string | 是 | - | - | 编码后的部分 URI | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个解码后的统一资源标识符（URI）字符串，处理前的 URI 经过了给定格式的编码。当 encodedURI 包含无效字符序列时，会返回null. | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.91 | 4.11 | 4.0 | 3.91 | 3.91 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.decodeURIComponent)"},"encodeURI":{"name":"### encodeURI(uri)","description":"encodeURI() 函数通过将特定字符的每个实例替换为一个、两个、三或四转义序列来对统一资源标识符 (URI) 进行编码 (该字符的 UTF-8 编码仅为四转义序列) 由两个 \"代理\" 字符组成)。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| uri | string | 是 | - | - | 一个完整的 URI。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 一个新字符串，表示提供的字符串编码为统一资源标识符 (URI)。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.91 | 4.11 | 4.0 | 3.91 | 3.91 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.encodeURI)"},"encodeURIComponent":{"name":"### encodeURIComponent(uriComponent)","description":"encodeURIComponent() 函数通过将特定字符的每个实例替换成代表字符的 UTF-8 编码的一个、两个、三个或四个转义序列来编码 URI（只有由两个“代理”字符组成的字符会被编码为四个转义序列）。与 encodeURI() 相比，此函数会编码更多的字符，包括 URI 语法的一部分。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| uriComponent | string | 是 | - | - | 要被检测的 string 值。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 原字串作为 URI 组成部分被被编码后的新字符串。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.91 | 4.11 | 4.0 | 3.91 | 3.91 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.encodeURIComponent)"},"setInterval":{"name":"### setInterval(handler, timeout?, ...arguments)","description":"setInterval() 方法重复调用一个函数或执行一个代码片段，在每次调用之间具有固定的时间间隔。
它返回一个 interval ID，该 ID 唯一地标识时间间隔，因此你可以稍后通过调用 clearInterval() 来移除定时器。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| handler | string \\| Function | 是 | - | - | - |\n| timeout | number | 是 | - | - | - |\n| arguments | any[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9 | 3.9 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.setInterval)"},"setTimeout":{"name":"### setTimeout(handler, timeout?, ...arguments)","description":"全局的 setTimeout() 方法设置一个定时器，一旦定时器到期，就会执行一个函数或指定的代码片段。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| handler | string \\| Function | 是 | - | - | - |\n| timeout | number | 是 | - | - | - |\n| arguments | any[\\] | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9 | 3.9 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.setTimeout)"},"clearInterval":{"name":"### clearInterval(id)","description":"clearInterval() 方法可取消先前通过 setInterval() 设置的重复定时任务。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| id | number \\| undefined | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9 | 3.9 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.clearInterval)"},"clearTimeout":{"name":"### clearTimeout(id)","description":"clearTimeout() 方法取消了先前通过调用setTimeout()建立的定时器","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| id | number \\| undefined | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | 4.11 | 4.0 | 3.9 | 3.9 | √ |\n","itemType":"method","tutorial":"\n**参见** \n\n [相关 Bug](https://issues.dcloud.net.cn/?mid=uts.timerMethods.clearTimeout)"}},"UTSAndroid":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UTSAndroid)","onAppConfigChange":{"name":"### onAppConfigChange(callback)","description":"监听 App配置发生变化, 对应 android原生 onAppConfigChange","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: UTSJSONObject) => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"offAppConfigChange":{"name":"### offAppConfigChange(callback?)","description":"onAppConfigChange 对应的反注册函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: UTSJSONObject) => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"onAppTrimMemory":{"name":"### onAppTrimMemory(callback?)","description":"注册监听 App 内存不足时的系统回调函数 对应原生的API: onTrimMemory","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: Number) => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"offAppTrimMemory":{"name":"### offAppTrimMemory(callback?)","description":"onAppTrimMemory 对应的反注册函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: Number) => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"onAppActivityPause":{"name":"### onAppActivityPause(callback)","description":"注册监听 activity onPause事件","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"offAppActivityPause":{"name":"### offAppActivityPause(callback?)","description":"onAppActivityPause 对应的反注册函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"onAppActivityResume":{"name":"### onAppActivityResume(callback)","description":"注册监听 activity onResume事件","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"offAppActivityResume":{"name":"### offAppActivityResume(callback?)","description":"onAppActivityResume 对应的反注册函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"onAppActivityDestroy":{"name":"### onAppActivityDestroy(callback)","description":"注册监听 activity onDestroy事件","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"offAppActivityDestroy":{"name":"### offAppActivityDestroy(callback?)","description":"onAppActivityDestroy 对应的反注册函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"onAppActivityResult":{"name":"### onAppActivityResult(callback)","description":"注册监听 activity onAppActivityResult 函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (requestCode: Int, resultCode: Int, data: any) => void | 是 | - | - | 用于监听的响应函数 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"offAppActivityResult":{"name":"### offAppActivityResult(callback?)","description":"onAppActivityResult 对应的反注册函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (requestCode: Int, resultCode: Int, data: any) => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"onAppActivityBack":{"name":"### onAppActivityBack(callback)","description":"注册监听 activity onAppActivityBack 函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | 用于监听的响应函数 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"offAppActivityBack":{"name":"### offAppActivityBack(callback?)","description":"取消注册监听 activity onAppActivityBack 函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | () => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getAppContext":{"name":"### getAppContext()","description":"获取当前应用Application上下文，对应android平台 Context.getApplicationContext 函数实现","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Context \\| null | 当前应用程序 上下文实例对象 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getUniActivity":{"name":"### getUniActivity()","description":"获取当前应用 栈顶的 Activity实例，对应android平台 getActivity 函数实现","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Activity \\| null | 当前应用栈顶的 Activity实例 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getTopPageActivity":{"name":"### getTopPageActivity()","description":"获取与当前页面绑定的activity对象，需要注意的是:当页面对象未与activity建立绑定关系时，可能为null","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Activity \\| null | 当前页面绑定的activity示例 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.0 | x | - | 4.0 | x | - |\n","itemType":"method"},"getResourcePath":{"name":"### getResourcePath(resourceName)","description":"获取资源文件的原生路径。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| resourceName | string | 是 | - | - | 资源文件相对于工程的绝对路径, 如：“/static/logo.png” | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 该资源在原生目录下的路径 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | √ | - |\n","itemType":"method"},"getJavaClass":{"name":"### getJavaClass(input)","description":"获取对象的jvm class实例","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| input | any | 是 | - | - | 任意不为空对象 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Class | 传入对象所对应的class实例 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.0 | x | - | 4.0 | x | - |\n","itemType":"method"},"getAppCachePath":{"name":"### getAppCachePath()","description":"获取app 临时目录。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string \\| null | 返回app临时目录路径。存放在该文件可能会在应用退出后被清理 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.99 | x | - | √ | x | - |\n","itemType":"method"},"exit":{"name":"### exit()","description":"退出当前应用","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getDispatcher":{"name":"### getDispatcher(threadName)","description":"获取一个任务分发器实例","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| threadName | string\\|null | 否 | - | - | 任务组名称，可能为：
main: ui thread / dom: 仅uni-app x环境生效，uni-app 环境会自动切换到 ui
io : io thread
匿名线程 null 或者 '': 来源线程，如果来源线程不支持任务分发，则会在当前线程执行执行. 这个场景下要求第一个参数必须是线程环境 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| [UTSTaskDispatcher](#utstaskdispatcher-values) | \n\n\n\n##### UTSTaskDispatcher 的方法 @utstaskdispatcher-values \n\n##### async(action, param?) @async\n在当前任务分发器 异步执行任务\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| action | (action?: any \\| null) => void | 是 | - | - | 任务函数 |\n| param | any \\| null | 否 | - | - | 任务函数需要的参数 | \n\n\n###### async 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getAppId":{"name":"### getAppId()","description":"获取当前运行的app的AppId。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 当前运行的app的AppId。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getOsTheme":{"name":"### getOsTheme()","description":"获取当前系统主题样式","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 系统主题样式 \"dark\":暗色模式 \"light\":亮色模式 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"isUniMp":{"name":"### isUniMp()","description":"获取当前运行环境是否是unimp。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 是否是unimp。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getAppName":{"name":"### getAppName()","description":"获取manifest.json 中配置的应用名称","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 应用名称。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getAppVersion":{"name":"### getAppVersion()","description":"获取manifest.json 中配置的应用版本信息","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UTSJSONObject | 应用版本信息 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"getInnerVersion":{"name":"### getInnerVersion()","description":"获取引擎版本号。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 引擎版本号。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"isUniAppX":{"name":"### isUniAppX()","description":"获取当前是否是uniapp x 环境","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | uniapp x 环境 true, uniapp 环境： false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | √ | x | - |\n","itemType":"method"},"rpx2px":{"name":"### rpx2px(rpx)","description":"","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| rpx | number | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 返回对应的逻辑像素值 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"rpx2px_1":{"name":"### rpx2px(rpx)","description":"页面的rpx像素转换为页面的px像素","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| rpx | number | 是 | - | - | 待转换的rpx | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 转换后的px | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.95 | x | - | 3.95 | x | - |\n","itemType":"method"},"isPrivacyAgree":{"name":"### isPrivacyAgree()","description":"当前应用是否已取得用户同意隐私协议","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | true 用户已同意 false 用户未同意 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"setPrivacyAgree":{"name":"### setPrivacyAgree(state)","description":"设置当前应用是否已取得用户同意隐私协议","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| state | boolean | 是 | - | - | true 用户已同意 false 用户未同意 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"resetPrivacyAgree":{"name":"### resetPrivacyAgree()","description":"重置当前应用至用户未同意隐私协议","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"requestSystemPermission":{"name":"### requestSystemPermission(context, requestPermission, success, fail)","description":"请求系统权限","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| context | Activity | 是 | - | - | - |\n| requestPermission | Array\\\\ | 是 | - | - | 期望请求的权限 |\n| success | (allRight: boolean, grantedList: Array\\) => void | 是 | - | - | - |\n| fail | (doNotAskAgain: boolean, grantedList: Array\\) => void | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"checkSystemPermissionGranted":{"name":"### checkSystemPermissionGranted(context, requestPermission)","description":"检查当前应用是否已经具备指定权限","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| context | Activity | 是 | - | - | - |\n| requestPermission | Array\\\\ | 是 | - | - | 期望具备的权限 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 请求的权限列表中是否已经具备 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"gotoSystemPermissionActivity":{"name":"### gotoSystemPermissionActivity(context, requestPermission)","description":"跳转至系统权限手动设备列表","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| context | Activity | 是 | - | - | - |\n| requestPermission | Array\\\\ | 是 | - | - | 期望请求的权限 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"getSystemPermissionDenied":{"name":"### getSystemPermissionDenied(context, requestPermission)","description":"获取当前应用不具备的权限列表","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| context | Activity | 是 | - | - | - |\n| requestPermission | Array\\\\ | 是 | - | - | 期望请求的权限 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Array\\ | 请求的权限列表中已经被禁用的部分 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9+ | x | - |\n","itemType":"method"},"devicePX2px":{"name":"### devicePX2px(devicePX)","description":"物理像素转换为页面的px像素","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| devicePX | number | 是 | - | - | 待转换的物理像素 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 转换后的页面px | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.95 | x | - | 3.95 | x | - |\n","itemType":"method"},"convert2AbsFullPath":{"name":"### convert2AbsFullPath(inputPath)","description":"将文件的项目相对地址转换为 运行期对应的绝对地址
eg.
'static/logo.png' -> '/storage/sdcard/0/apps/com.xxxx/files/logo.png'
","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| inputPath | string | 是 | - | - | 待转换的文件相对路径 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 转换后文件绝对路径 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.9 | x | - | 3.9 | x | - |\n","itemType":"method"},"getFileProviderUri":{"name":"### getFileProviderUri(file)","description":"将应用的私有文件 通过内置的FileProvider转换为外部应用可以访问的Uri
","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| file | File | 是 | - | - | 待转换的私有文件 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Uri | 转换后的Uri | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.99 | x | - | 3.99 | x | - |\n","itemType":"method"},"getExtApiProvider":{"name":"### getExtApiProvider(service, providerName)","description":"获取指定service的指定provider实现
","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| service | string | 是 | - | - | 指定的服务名称 |\n| providerName | string | 是 | - | - | 指定provider名称 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| T \\| null | 指定 provider 实例 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.14 | x | - | 4.14 | x | - |\n","itemType":"method"},"onPrivacyAgreeChange":{"name":"### onPrivacyAgreeChange(callback)","description":"注册监听隐私协议更改回调
","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (option: [PrivacyOption](#privacyoption-values)) => void | 是 | - | - | 回调方法 | \n\n##### PrivacyOption 的属性值 @privacyoption-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| isAgree | boolean | 是 | - | - | 是否同意用户隐私协议 |\n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | 4.18 | x | - |\n","itemType":"method"},"offPrivacyAgreeChange":{"name":"### offPrivacyAgreeChange(callback)","description":"onPrivacyAgreeChange对应的反注册函数
","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (option: [PrivacyOption](#privacyoption-values)) => void | 是 | - | - | onPrivacyAgreeChange中传入的callback | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | 4.18 | x | - |\n","itemType":"method"},"onActivityCallback":{"name":"### onActivityCallback(callback, pageRoute?)","description":"注册监听activity回调方法
","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | IUniActivityCallback | 是 | - | - | 回调方法，[查看具体子类实现](https://doc.dcloud.net.cn/uni-app-x/uts/utsactivitycallback.html) |\n| pageRoute | string\\|null | 否 | - | - | [页面的路由地址route](https://doc.dcloud.net.cn/uni-app-x/api/get-current-pages.html#getcurrentpages),注意如果是tabBar页面,请传'tabBar'字符串 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"offActivityCallback":{"name":"### offActivityCallback(callback)","description":"onActivityCallback对应的反注册函数。
","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | IUniActivityCallback | 是 | - | - | onActivityCallback传入的callback | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"setAppTheme":{"name":"### setAppTheme(theme)","description":"设置app主题","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| theme | string | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onAppThemeChanged":{"name":"### onAppThemeChanged(callback)","description":"监听app主题变化","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: UTSJSONObject) => void | 是 | - | - | app主题变化回调函数 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"offAppThemeChanged":{"name":"### offAppThemeChanged(callbackId)","description":"注销app主题监听","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackId | number | 是 | - | - | callback监听id | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onOsThemeChanged":{"name":"### onOsThemeChanged(callback)","description":"监听系统主题变化","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (res: UTSJSONObject) => void | 是 | - | - | 主题变化回调函数 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"offOsThemeChanged":{"name":"### offOsThemeChanged(callbackId)","description":"注销系统主题监听","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackId | number | 是 | - | - | callback监听id | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"}},"UTSiOS":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UTSiOS)","getCurrentViewController":{"name":"### getCurrentViewController()","description":"获取当前 app 显示的 UIViewController。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UIViewController | 当前 app 显示的 UIViewController | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getKeyWindow":{"name":"### getKeyWindow()","description":"获取当前app的keyWindow。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UIWindow | 当前app的keyWindow. | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"colorWithString":{"name":"### colorWithString(value)","description":"获取指定的颜色。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| value | string | 是 | - | - | 需要转换的代表色值的字符串，支持一下格式：精简写法的十六进制 如：#f00，十六进制 如：#ff0000，RGB 如：rgb(255, 0, 0)，RGBA 如:rgba(255, 0, 0, 0.5)，色值关键字，如： red | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| UIColor | UIColor 实例对象 注：如转换失败 默认会返回 黑色 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getResourcePath":{"name":"### getResourcePath(resourceName)","description":"获取H5资源文件的原生路径。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| resourceName | string | 是 | - | - | H5资源文件相对于工程的绝对路径, 如：“/static/logo.png” | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 该资源在原生目录下的路径 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"isSimulator":{"name":"### isSimulator()","description":"是否是模拟器。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 当前是模拟器 true, 当前是真机：false | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getDeviceId":{"name":"### getDeviceId()","description":"获取设备 deviceId。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 当前设备的 deviceId | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getModel":{"name":"### getModel()","description":"获取设备型号。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getUserAgent":{"name":"### getUserAgent()","description":"获取当前应用的 UserAgent。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 当前应用的 UserAgent。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getAppId":{"name":"### getAppId()","description":"获取当前运行的app的AppId。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 当前运行的app的AppId。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getDataPath":{"name":"### getDataPath()","description":"获取当前运行app的dataPath","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 当前运行app的dataPath。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"isUniMp":{"name":"### isUniMp()","description":"获取当前运行环境是否是unimp。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 是否是unimp。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getAppName":{"name":"### getAppName()","description":"获取manifest.json 中配置的应用名称","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 应用名称。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getAppVersion":{"name":"### getAppVersion()","description":"获取manifest.json 中配置的应用版本名称。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 应用版本名称。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getAppVersionCode":{"name":"### getAppVersionCode()","description":"获取manifest.json 中配置的应用版本号。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 应用版本号。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getOsLanguage":{"name":"### getOsLanguage()","description":"获取操作系统设置的语言。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | os language。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getAppWgtVersion":{"name":"### getAppWgtVersion()","description":"获取应用资源（wgt）的版本名称。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 应用资源（wgt）的版本名称。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getInnerVersion":{"name":"### getInnerVersion()","description":"获取引擎版本号。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 引擎版本号。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getSystemSetting":{"name":"### getSystemSetting()","description":"获取系统设置信息。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| Map\\ | 系统设置信息。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"isBaseIpa":{"name":"### isBaseIpa()","description":"获取当前是否是基座环境。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 基座环境 true, 线上环境： false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | √ | - |\n","itemType":"method"},"getOsTheme":{"name":"### getOsTheme()","description":"获取系统当前主题。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 系统当前主题信息。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | √ | - |\n","itemType":"method"},"onOsThemeChange":{"name":"### onOsThemeChange(callback)","description":"监听系统主题变化（需要调用取消监听避免内存泄露）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (theme: string) => void | 是 | - | - | 监听函数 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 监听id。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | √ | - |\n","itemType":"method"},"offOsThemeChange":{"name":"### offOsThemeChange(callbackId)","description":"取消监听系统主题变化。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackId | number | 是 | - | - | 监听id | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | √ | - |\n","itemType":"method"},"getAppTheme":{"name":"### getAppTheme()","description":"获取App当前主题。","param":"","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| string | App当前主题信息。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | √ | - |\n","itemType":"method"},"setAppTheme":{"name":"### setAppTheme(theme)","description":"设置App当前主题。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| theme | string | 是 | - | - | 要设置的主题信息 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| void | App当前主题信息。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | √ | - |\n","itemType":"method"},"onAppThemeChange":{"name":"### onAppThemeChange(callback)","description":"监听app theme变化（需要调用取消监听避免内存泄露）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (theme: string) => void | 是 | - | - | 监听函数 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| number | 监听id。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | √ | - |\n","itemType":"method"},"offAppThemeChange":{"name":"### offAppThemeChange(callbackId)","description":"取消监听app theme变化。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callbackId | number | 是 | - | - | 监听id | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | √ | - |\n","itemType":"method"}},"UTSiOSHookProxy":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UTSiOSHookProxy)","onCreate":{"name":"### onCreate()","description":"uts 插件创建时的回调。
此回调的准确时机对应于 OC 类的 load() 函数调用时机。","param":"","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationDidFinishLaunchingWithOptions":{"name":"### applicationDidFinishLaunchingWithOptions(application?, launchOptions?)","description":"应用正常启动时 (不包括已在后台转到前台的情况)的回调函数。
可以在此回调函数做一些初始化操作，比如初始依赖的SDK等。注意：不要在此回调函数里做耗时操作，以免影响 app 的启动速度。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| application | UIApplication | 是 | - | - | App 的 UIApplicationDelegate 对象。 |\n| launchOptions | Map\\ | 是 | - | - | 启动参数。默认值为 null (用户通过点击 push 通知启动应用时，该参数内会包含通知的信息) | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 返回一个 boolean 值，正常返回true。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"didRegisterForRemoteNotifications":{"name":"### didRegisterForRemoteNotifications(deviceToken?)","description":"远程通知注册成功时的回调函数。
可以在此函数里将 deviceToken 发送给服务端。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| deviceToken | Data | 是 | - | - | 设备的推送令牌 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | 3.97+ | - |\n","itemType":"method"},"didFailToRegisterForRemoteNotifications":{"name":"### didFailToRegisterForRemoteNotifications(error?)","description":"远程通知注册失败时的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| error | NSError | 是 | - | - | 失败的原因。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | 3.97+ | - |\n","itemType":"method"},"didReceiveRemoteNotification":{"name":"### didReceiveRemoteNotification(userInfo?)","description":"应用收到远程通知时的回调函数。(iOS 10.0之后废弃)
当应用在前台运行中，收到远程通知时(不会弹出系统通知界面)，会回调这个方法；当应用在后台状态时，点击push消息启动应用，也会回调这个方法；当应用完全没有启动时，点击push消息启动应用，就不会回调这个方法。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| userInfo | Map\\ | 是 | - | - | 收到的远程通知信息。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | 3.97+ | - |\n","itemType":"method"},"didReceiveLocalNotification":{"name":"### didReceiveLocalNotification(notification?)","description":"应用收到本地通知时的回调函数。(iOS 10.0之后废弃)","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| notification | UILocalNotification | 是 | - | - | 接收到的本地通知 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.18 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationHandleOpenURL":{"name":"### applicationHandleOpenURL(application?, url?)","description":"通过 url scheme 方式唤起 app 时的回调函数。(iOS9 之前的系统回调此方法，iOS9 之后的系统请使用 applicationOpenURLOptions)","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| application | UIApplication | 是 | - | - | App 的 UIApplicationDelegate 对象。 |\n| url | [URL](#url-values) | 是 | - | - | 要打开的URL资源。该资源可以是网络资源或文件。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| hash | string | 是 | - | - | Gets and sets the fragment portion of the URL.

```js
const myURL = new URL('https://example.org/foo#bar');
console.log(myURL.hash);
// Prints #bar

myURL.hash = 'baz';
console.log(myURL.href);
// Prints https://example.org/foo#baz
```

Invalid URL characters included in the value assigned to the `hash` property
are `percent-encoded`. The selection of which characters to
percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce. |\n@| host | string | 是 | - | - | Gets and sets the host portion of the URL.

```js
const myURL = new URL('https://example.org:81/foo');
console.log(myURL.host);
// Prints example.org:81

myURL.host = 'example.com:82';
console.log(myURL.href);
// Prints https://example.com:82/foo
```

Invalid host values assigned to the `host` property are ignored. |\n@| hostname | string | 是 | - | - | Gets and sets the host name portion of the URL. The key difference between`url.host` and `url.hostname` is that `url.hostname` does _not_ include the
port.

```js
const myURL = new URL('https://example.org:81/foo');
console.log(myURL.hostname);
// Prints example.org

// Setting the hostname does not change the port
myURL.hostname = 'example.com:82';
console.log(myURL.href);
// Prints https://example.com:81/foo

// Use myURL.host to change the hostname and port
myURL.host = 'example.org:82';
console.log(myURL.href);
// Prints https://example.org:82/foo
```

Invalid host name values assigned to the `hostname` property are ignored. |\n@| href | string | 是 | - | - | Gets and sets the serialized URL.

```js
const myURL = new URL('https://example.org/foo');
console.log(myURL.href);
// Prints https://example.org/foo

myURL.href = 'https://example.com/bar';
console.log(myURL.href);
// Prints https://example.com/bar
```

Getting the value of the `href` property is equivalent to calling {@link toString}.

Setting the value of this property to a new value is equivalent to creating a
new `URL` object using `new URL(value)`. Each of the `URL`object's properties will be modified.

If the value assigned to the `href` property is not a valid URL, a `TypeError`will be thrown. |\n@| origin | string | 是 | - | - | Gets the read-only serialization of the URL's origin.

```js
const myURL = new URL('https://example.org/foo/bar?baz');
console.log(myURL.origin);
// Prints https://example.org
```

```js
const idnURL = new URL('https://測試');
console.log(idnURL.origin);
// Prints https://xn--g6w251d

console.log(idnURL.hostname);
// Prints xn--g6w251d
``` |\n@| password | string | 是 | - | - | Gets and sets the password portion of the URL.

```js
const myURL = new URL('https://abc:xyz@example.com');
console.log(myURL.password);
// Prints xyz

myURL.password = '123';
console.log(myURL.href);
// Prints https://abc:123@example.com
```

Invalid URL characters included in the value assigned to the `password` property
are `percent-encoded`. The selection of which characters to
percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce. |\n@| pathname | string | 是 | - | - | Gets and sets the path portion of the URL.

```js
const myURL = new URL('https://example.org/abc/xyz?123');
console.log(myURL.pathname);
// Prints /abc/xyz

myURL.pathname = '/abcdef';
console.log(myURL.href);
// Prints https://example.org/abcdef?123
```

Invalid URL characters included in the value assigned to the `pathname`property are `percent-encoded`. The selection of which characters
to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce. |\n@| port | string | 是 | - | - | Gets and sets the port portion of the URL.

The port value may be a number or a string containing a number in the range`0` to `65535` (inclusive). Setting the value to the default port of the`URL` objects given `protocol` will
result in the `port` value becoming
the empty string (`''`).

The port value can be an empty string in which case the port depends on
the protocol/scheme:

\\

Upon assigning a value to the port, the value will first be converted to a
string using `.toString()`.

If that string is invalid but it begins with a number, the leading number is
assigned to `port`.
If the number lies outside the range denoted above, it is ignored.

```js
const myURL = new URL('https://example.org:8888');
console.log(myURL.port);
// Prints 8888

// Default ports are automatically transformed to the empty string
// (HTTPS protocol's default port is 443)
myURL.port = '443';
console.log(myURL.port);
// Prints the empty string
console.log(myURL.href);
// Prints https://example.org/

myURL.port = 1234;
console.log(myURL.port);
// Prints 1234
console.log(myURL.href);
// Prints https://example.org:1234/

// Completely invalid port strings are ignored
myURL.port = 'abcd';
console.log(myURL.port);
// Prints 1234

// Leading numbers are treated as a port number
myURL.port = '5678abcd';
console.log(myURL.port);
// Prints 5678

// Non-integers are truncated
myURL.port = 1234.5678;
console.log(myURL.port);
// Prints 1234

// Out-of-range numbers which are not represented in scientific notation
// will be ignored.
myURL.port = 1e10; // 10000000000, will be range-checked as described below
console.log(myURL.port);
// Prints 1234
```

Numbers which contain a decimal point,
such as floating-point numbers or numbers in scientific notation,
are not an exception to this rule.
Leading numbers up to the decimal point will be set as the URL's port,
assuming they are valid:

```js
myURL.port = 4.567e21;
console.log(myURL.port);
// Prints 4 (because it is the leading number in the string '4.567e21')
``` |\n@| protocol | string | 是 | - | - | Gets and sets the protocol portion of the URL.

```js
const myURL = new URL('https://example.org');
console.log(myURL.protocol);
// Prints https:

myURL.protocol = 'ftp';
console.log(myURL.href);
// Prints ftp://example.org/
```

Invalid URL protocol values assigned to the `protocol` property are ignored. |\n@| search | string | 是 | - | - | Gets and sets the serialized query portion of the URL.

```js
const myURL = new URL('https://example.org/abc?123');
console.log(myURL.search);
// Prints ?123

myURL.search = 'abc=xyz';
console.log(myURL.href);
// Prints https://example.org/abc?abc=xyz
```

Any invalid URL characters appearing in the value assigned the `search`property will be `percent-encoded`. The selection of which
characters to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce. |\n@| searchParams | [URLSearchParams](#urlsearchparams-values) | 是 | - | - | Gets the `URLSearchParams` object representing the query parameters of the
URL. This property is read-only but the `URLSearchParams` object it provides
can be used to mutate the URL instance; to replace the entirety of query
parameters of the URL, use the {@link search} setter. See `URLSearchParams` documentation for details.

Use care when using `.searchParams` to modify the `URL` because,
per the WHATWG specification, the `URLSearchParams` object uses
different rules to determine which characters to percent-encode. For
instance, the `URL` object will not percent encode the ASCII tilde (`~`)
character, while `URLSearchParams` will always encode it:

```js
const myUrl = new URL('https://example.org/abc?foo=~bar');

console.log(myUrl.search); // prints ?foo=~bar

// Modify the URL via searchParams...
myUrl.searchParams.sort();

console.log(myUrl.search); // prints ?foo=%7Ebar
``` |\n@| username | string | 是 | - | - | Gets and sets the username portion of the URL.

```js
const myURL = new URL('https://abc:xyz@example.com');
console.log(myURL.username);
// Prints abc

myURL.username = '123';
console.log(myURL.href);
// Prints https://123:xyz@example.com/
```

Any invalid URL characters appearing in the value assigned the `username`property will be `percent-encoded`. The selection of which
characters to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce. | \n\n##### URLSearchParams 的方法 @urlsearchparams-values \n\n##### append(name, value) @append\nAppend a new name-value pair to the query string.\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - |\n| value | string | 是 | - | - | - | \n\n\n###### append 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### delete(name) @delete\nRemove all name-value pairs whose name is `name`.\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - | \n\n\n###### delete 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### entries() @entries\nReturns an ES6 `Iterator` over each of the name-value pairs in the query.
Each item of the iterator is a JavaScript `Array`. The first item of the `Array`is the `name`, the second item of the `Array` is the `value`.

Alias for `urlSearchParams[@@iterator]()`.\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| IterableIterator\\<\\[string, string\\] |\n \n\n###### entries 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### forEach(callback, thisArg?) @foreach\nIterates over each name-value pair in the query and invokes the given function.

```js
const myURL = new URL('https://example.org/?a=b&c=d');
myURL.searchParams.forEach((value, name, searchParams) => {
console.log(name, value, myURL.searchParams === searchParams);
});
// Prints:
// a b true
// c d true
```\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (this: any, value: string, name: string, searchParams: [URLSearchParams](#urlsearchparams-values)) => void | 是 | - | - | Invoked for each name-value pair in the query |\n| thisArg | any | 否 | - | - | To be used as `this` value for when `fn` is called | \n\n\n###### forEach 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### get(name) @get\nReturns the value of the first name-value pair whose name is `name`. If there
are no such pairs, `null` is returned.\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| string \\| null | 否 |\n \n\n###### get 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### getAll(name) @getall\nReturns the values of all name-value pairs whose name is `name`. If there are
no such pairs, an empty array is returned.\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Array\\ |\n \n\n###### getAll 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### has(name) @has\nReturns `true` if there is at least one name-value pair whose name is `name`.\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| boolean |\n \n\n###### has 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### keys() @keys\nReturns an ES6 `Iterator` over the names of each name-value pair.

```js
const params = new URLSearchParams('foo=bar&foo=baz');
for (const name of params.keys()) {
console.log(name);
}
// Prints:
// foo
// foo
```\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| IterableIterator\\ |\n \n\n###### keys 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### set(name, value) @set\nSets the value in the `URLSearchParams` object associated with `name` to`value`. If there are any pre-existing name-value pairs whose names are `name`,
set the first such pair's value to `value` and remove all others. If not,
append the name-value pair to the query string.

```js
const params = new URLSearchParams();
params.append('foo', 'bar');
params.append('foo', 'baz');
params.append('abc', 'def');
console.log(params.toString());
// Prints foo=bar&foo=baz&abc=def

params.set('foo', 'def');
params.set('xyz', 'opq');
console.log(params.toString());
// Prints foo=def&abc=def&xyz=opq
```\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| name | string | 是 | - | - | - |\n| value | string | 是 | - | - | - | \n\n\n###### set 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### sort() @sort\nSort all existing name-value pairs in-place by their names. Sorting is done
with a \\[stable sorting algorithm](https://en.wikipedia.org/wiki/Sorting_algorithm#Stability), so relative order between name-value pairs
with the same name is preserved.

This method can be used, in particular, to increase cache hits.

```js
const params = new URLSearchParams('query[]=abc&type=search&query[]123');
params.sort();
console.log(params.toString());
// Prints query%5B%5D=abc&query%5B%5D=123&type=search
```\n\n\n###### sort 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### toString() @tostring\nReturns the search parameters serialized as a string, with characters
percent-encoded where necessary.\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| string |\n \n\n###### toString 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### values() @values\nReturns an ES6 `Iterator` over the values of each name-value pair.\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| IterableIterator\\ |\n \n\n###### values 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### URL 的方法 @url-values \n\n##### toString() @tostring\nThe `toString()` method on the `URL` object returns the serialized URL. The
value returned is equivalent to that of {@link href} and {@link toJSON}.\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| string |\n \n\n###### toString 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### toJSON() @tojson\nThe `toJSON()` method on the `URL` object returns the serialized URL. The
value returned is equivalent to that of {@link href} and {@link toString}.

This method is automatically called when an `URL` object is serialized
with \\[`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify).

```js
const myURLs = [
new URL('https://www.example.com'),
new URL('https://test.example.org'),
];
console.log(JSON.stringify(myURLs));
// Prints [\"https://www.example.com/\",\"https://test.example.org/\"]```\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| string |\n \n\n###### toJSON 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果成功处理请求，则为true;如果尝试打开URL资源失败，则为false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationOpenURLOptions":{"name":"### applicationOpenURLOptions(app?, url?, options?)","description":"通过 url scheme 方式唤起 app 时的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| app | UIApplication | 是 | - | - | - |\n| url | [URL](#url-values) | 是 | - | - | 要打开的URL资源。该资源可以是网络资源或文件。 |\n| options | Map\\ | 是 | - | - | URL处理选项的字典, 默认值为 null 。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | 如果成功处理请求，则为true;如果尝试打开URL资源失败，则为false。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationWillResignActive":{"name":"### applicationWillResignActive(application?)","description":"当应用从活动状态主动变为非活动状态的时的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| application | UIApplication | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationDidBecomeActive":{"name":"### applicationDidBecomeActive(application?)","description":"应用完全激活时的回调函数。
应用程序冷启动或者从后台转到前台后都会完全激活应用程序。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| application | UIApplication | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationDidEnterBackground":{"name":"### applicationDidEnterBackground(application?)","description":"应用程序进入后台时的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| application | UIApplication | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationWillEnterForeground":{"name":"### applicationWillEnterForeground(application?)","description":"当应用在后台状态，将要进入到前台运行时的回调函数。
应用程序冷启动时不会回调此方法。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| application | UIApplication | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationMain":{"name":"### applicationMain(argc, argv)","description":"应用程序的 main 函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| argc | Int32 | 是 | - | - | - |\n| argv | UnsafeMutablePointer\\ \\| null> | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"},"applicationContinueUserActivityRestorationHandler":{"name":"### applicationContinueUserActivityRestorationHandler(application?, userActivity?, restorationHandler?)","description":"当应用程序接收到与用户活动相关的数据时调用此方法，例如，当用户使用 Universal Link 唤起应用时。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| application | UIApplication | 是 | - | - | App 的 UIApplicationDelegate 对象。 |\n| userActivity | NSUserActivity | 是 | - | - | 包含与用户正在执行的任务相关联的数据的活动对象。使用这些数据来继续用户在iOS应用中的活动。 |\n| restorationHandler | ((res ?: \\\\[any]=> void) | 是 | - | - | 需要执行的回调，该回调是可选的，默认值为 null。 | \n","returnValue":"**返回值** \n\n| 类型 | 描述 |\n| :- | :- |\n| boolean | true表示你的应用处理了这个活动，false表示让iOS知道你的应用没有处理这个活动。 | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| x | 4.11 | - | x | 3.97+ | - |\n","itemType":"method"}},"UTSAndroidHookProxy":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UTSAndroidHookProxy)","onCreate":{"name":"### onCreate(application)","description":"uts 插件创建时的回调。
对应原生 Application onCreate 函数","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| application | Application | 是 | - | - | - | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 3.97 | x | - | x | x | - |\n","itemType":"method"}},"UniActivityCallback":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UniActivityCallback)","onAttachFragment":{"name":"### onAttachFragment(params, fragment)","description":"对应原生 Activity 的 [onAttachFragment](https://developer.android.com/reference/android/app/Activity#onAttachFragment(android.app.Fragment)) 函数，此方法在 Fragment 被附加到 Activity 时被调用，以处理相关联的逻辑。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 fragment 表示被附加的 Fragment 实例。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| fragment | Fragment | 是 | - | - | 被附加的 Fragment 实例 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onUserInteraction":{"name":"### onUserInteraction(params)","description":"对应原生 Activity 的 [onUserInteraction](https://developer.android.com/reference/android/app/Activity#onUserInteraction()) 函数，该方法在用户与设备进行交互时被调用，用于处理用户交互前的逻辑。
注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onUserLeaveHint":{"name":"### onUserLeaveHint(params)","description":"对应原生 Activity 的 [onUserLeaveHint](https://developer.android.com/reference/android/app/Activity#onUserLeaveHint()) 函数，此方法在用户即将离开应用且返回到上一级活动（通过按Home键等操作造成的）时被调用，用于处理用户即将离开应用前的逻辑。
注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onActivityResult":{"name":"### onActivityResult(params, requestCode, resultCode, data)","description":"对应原生 Activity 的 [onActivityResult](https://developer.android.com/reference/android/app/Activity#onActivityResult(int,%20int,%20android.content.Intent)) 函数，此方法在从另一个活动返回数据时被调用，用于处理返回数据前的逻辑。
注意第一个参数为自定义参数 UniActivityParams，第二和第三个参数分别代表请求代码和结果代码，第四个参数 data 为返回的数据。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| requestCode | Int | 是 | - | - | 请求代码 |\n| resultCode | Int | 是 | - | - | 结果代码 |\n| data | Intent \\| null | 否 | - | - | 返回的数据 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onRequestPermissionsResult":{"name":"### onRequestPermissionsResult(params, requestCode, permissions, grantResults)","description":"对应原生 Activity 的 \\[onRequestPermissionsResult](https://developer.android.com/reference/android/app/Activity#onRequestPermissionsResult(int,%20java.lang.String[],%20int[]) 函数，此方法在用户响应权限请求后被调用，用于处理权限请求结果前的逻辑。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 requestCode 为请求代码，第三个参数 permissions 为请求的权限数组，第四个参数 grantResults 为权限请求结果数组。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| requestCode | Int | 是 | - | - | 请求代码 |\n| permissions | MutableList\\ | 是 | - | - | 请求的权限 |\n| grantResults | IntArray | 是 | - | - | 权限请求结果 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onApplyThemeResource":{"name":"### onApplyThemeResource(params, theme, resid, first)","description":"对应原生 Activity 的 [onApplyThemeResource](https://developer.android.com/reference/android/app/Activity#onApplyThemeResource(android.content.res.Resources.Theme,%20int,%20boolean)) 函数，此方法在应用主题资源时被调用，用于处理主题资源应用前的逻辑。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 theme 为要应用的主题资源，第三个参数 resid 为资源ID，第四个参数 first 标示是否为首次应用。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| theme | Resources.Theme | 是 | - | - | 要应用的主题资源 |\n| resid | Int | 是 | - | - | 资源ID |\n| first | Boolean | 是 | - | - | 是否为首次应用 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onCreateView":{"name":"### onCreateView(params, parent, name, context, attrs)","description":"对应原生 Activity 的 [onCreateView](https://developer.android.com/reference/android/app/Activity#onCreateView(android.view.View,%20java.lang.String,%20android.content.Context,%20android.util.AttributeSet))函数，此方法在视图创建时被调用，用于处理视图创建前的逻辑。
注意第一个参数为自定义参数 UniActivityParams，后续参数分别为 parent 视图的父视图，name 视图名称，context 视图的上下文环境及 attrs 视图的属性集。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| parent | View \\| null | 否 | - | - | 父视图 |\n| name | string | 是 | - | - | 视图名称 |\n| context | Context | 是 | - | - | 上下文环境 |\n| attrs | AttributeSet | 是 | - | - | 属性集 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onTitleChanged":{"name":"### onTitleChanged(params, title, color)","description":"对应原生 Activity [onTitleChanged](https://developer.android.com/reference/android/app/Activity#onTitleChanged(java.lang.CharSequence,%20int)) 函数，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| title | string | 是 | - | - | 新的标题字符 |\n| color | Int | 是 | - | - | 新的标题颜色 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onChildTitleChanged":{"name":"### onChildTitleChanged(params, childActivity, title)","description":"对应原生 Activity [onChildTitleChanged](https://developer.android.com/reference/android/app/Activity#onChildTitleChanged(android.app.Activity,%20java.lang.CharSequence)) 函数，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| childActivity | Activity | 是 | - | - | 子Activity的实例 |\n| title | string | 是 | - | - | 新的子Activity标题字符 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onBackPressed":{"name":"### onBackPressed(params)","description":"对应原生 Activity [onBackPressed](https://developer.android.com/reference/android/app/Activity#onBackPressed()) 函数，注意第一个参数为自定义参数 UniActivityParams。
当用户尝试回退当前页面时调用，可用于自定义回退行为或拦截回退事件。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onContextMenuClosed":{"name":"### onContextMenuClosed(params, menu)","description":"对应原生 Activity [onContextMenuClosed](https://developer.android.com/reference/android/app/Activity#onContextMenuClosed(android.view.Menu)) 函数，注意第一个参数为自定义参数 UniActivityParams。
当上下文菜单被关闭时调用，可用于执行菜单关闭后的操作。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| menu | Menu | 是 | - | - | 关闭的菜单 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onCreateContextMenu":{"name":"### onCreateContextMenu(params, menu, v, menuInfo)","description":"对应原生 Activity [onCreateContextMenu](https://developer.android.com/reference/android/app/Activity#onCreateContextMenu(android.view.ContextMenu,%20android.view.View,%20android.view.ContextMenu.ContextMenuInfo)) 函数，注意第一个参数为自定义参数 UniActivityParams。
当创建上下文菜单时调用，可用于定制上下文菜单的内容。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| menu | ContextMenu | 是 | - | - | 要创建的上下文菜单 |\n| v | View | 是 | - | - | 与上下文菜单相关联的视图 |\n| menuInfo | ContextMenu.ContextMenuInfo \\| null | 否 | - | - | 关联上下文菜单的附加信息，可为空 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onOptionsMenuClosed":{"name":"### onOptionsMenuClosed(params, menu)","description":"对应原生 Activity [onOptionsMenuClosed](https://developer.android.com/reference/android/app/Activity#onOptionsMenuClosed(android.view.Menu)) 函数，注意第一个参数为自定义参数 UniActivityParams。
当选项菜单被关闭时调用。可用于执行菜单关闭后的操作。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| menu | Menu | 是 | - | - | 关闭的菜单 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPrepareNavigateUpTaskStack":{"name":"### onPrepareNavigateUpTaskStack(params, builder)","description":"对应原生 Activity [onPrepareNavigateUpTaskStack](https://developer.android.com/reference/android/app/Activity#onPrepareNavigateUpTaskStack(android.app.TaskStackBuilder)) 函数，注意第一个参数为自定义参数 UniActivityParams。
此方法在用户从当前 Activity 导航到应用的祖先 Activity 时调用，以准备返回栈。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| builder | TaskStackBuilder | 是 | - | - | 返回栈建造者，用于构造导航返回栈 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onProvideAssistData":{"name":"### onProvideAssistData(params, data)","description":"对应原生 Activity [onProvideAssistData](https://developer.android.com/reference/android/app/Activity#onProvideAssistData(android.os.Bundle)) 函数，注意第一个参数为自定义参数 UniActivityParams。
此方法在构建辅助数据时被调用，比如在使用 Google Now 时展示有关当前 Activity 的信息。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| data | Bundle | 是 | - | - | 提供辅助数据的 Bundle | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onProvideAssistContent":{"name":"### onProvideAssistContent(params, outContent)","description":"对应原生 Activity [onProvideAssistContent](https://developer.android.com/reference/android/app/Activity#onProvideAssistContent(android.app.assist.AssistContent)) 函数，注意第一个参数为自定义参数 UniActivityParams。
此方法允许Activity提供有关其当前在屏幕上显示的内容的附加信息，这有助于提升语音搜索等辅助功能的体验。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| outContent | AssistContent | 是 | - | - | 通过这个参数，Activity可以提供有关其内容的结构化信息。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreAttachFragment":{"name":"### onPreAttachFragment(params, fragment)","description":"对应原生 Activity [onAttachFragment](https://developer.android.com/reference/android/app/Activity#onAttachFragment(android.app.Fragment)) 函数，该方法在Fragment与Activity建立关联时调用。本方法的调用时机在super.onAttachFragment()之前，它允许您在Fragment完全附加到Activity之前进行必要的设置或初始化。
提在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| fragment | Fragment | 是 | - | - | 即将附加的Fragment对象。这允许Activity在Fragment完全附加之前与之交互。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreUserInteraction":{"name":"### onPreUserInteraction(params)","description":"对应原生 Activity [onUserInteraction](https://developer.android.com/reference/android/app/Activity#onUserInteraction()) 函数。
在用户与设备进行交互时被调用，例如触摸屏幕或按键。开发者可以覆盖此方法以执行特定操作，如取消自动隐藏的导航控件等。
在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreUserLeaveHint":{"name":"### onPreUserLeaveHint(params)","description":"对应原生 Activity [onUserLeaveHint](https://developer.android.com/reference/android/app/Activity#onUserLeaveHint()) 函数。
当用户即将离开当前Activity时被调用，通常是因为用户按了 \"Home\" 键或最近任务键。可以覆盖此方法来实现特定的暂停、保存状态或资源释放操作。
在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreActivityResult":{"name":"### onPreActivityResult(params, requestCode, resultCode, data)","description":"对应原生 Activity [onActivityResult](https://developer.android.com/reference/android/app/Activity#onActivityResult(int,%20int,%20android.content.Intent)) 函数。
当一个启动的Activity返回结果时调用。在super方法之前调用。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| requestCode | Int | 是 | - | - | 请求代码，标识发送请求的Activity |\n| resultCode | Int | 是 | - | - | 结果代码，表明操作是否成功或取消 |\n| data | Intent \\| null | 否 | - | - | 含返回数据的Intent对象或null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreApplyThemeResource":{"name":"### onPreApplyThemeResource(params, theme, resid, first)","description":"对应原生 Activity [onApplyThemeResource](https://developer.android.com/reference/android/app/Activity#onApplyThemeResource(android.content.res.Resources.Theme,int,boolean)) 函数。
在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| theme | Resources.Theme | 是 | - | - | 当前 Activity 即将应用的主题资源 |\n| resid | Int | 是 | - | - | 用于应用主题的资源ID |\n| first | Boolean | 是 | - | - | 是否为第一次应用该主题 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreCreateView":{"name":"### onPreCreateView(params, parent, name, context, attrs)","description":"对应原生 Activity [onCreateView](https://developer.android.com/reference/android/app/Activity#onCreateView(android.view.View,java.lang.String,android.content.Context,android.util.AttributeSet)) 函数。
在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| parent | View \\| null | 否 | - | - | 即将创建视图的父视图 |\n| name | [String](#string-values) | 是 | - | - | 视图的标识名 |\n| context | Context | 是 | - | - | 视图创建时的上下文 |\n| attrs | AttributeSet | 是 | - | - | 视图的属性集 | \n\n##### String 的方法 @string-values \n\n##### at(index) @at\nTakes an integer value and returns the item at that index,
allowing for positive and negative integers.
Negative integers count back from the last item in the array.\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| index | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| T \\| any |\n \n\n###### at 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreTitleChanged":{"name":"### onPreTitleChanged(params, title, color)","description":"对应原生 Activity [onTitleChanged](https://developer.android.com/reference/android/app/Activity#onTitleChanged(java.lang.CharSequence,%20int)) 函数，
在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| title | [String](#string-values) | 是 | - | - | 即将设置的新标题。 |\n| color | Int | 是 | - | - | 标题的颜色。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreChildTitleChanged":{"name":"### onPreChildTitleChanged(params, childActivity, title)","description":"对应原生 Activity [onChildTitleChanged](https://developer.android.com/reference/android/app/Activity#onChildTitleChanged(android.app.Activity,%20java.lang.CharSequence)) 函数，
在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| childActivity | Activity | 是 | - | - | 标题变更的子Activity。 |\n| title | [String](#string-values) | 是 | - | - | 即将设置的新标题。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreBackPressed":{"name":"### onPreBackPressed(params)","description":"对应原生 Activity [onBackPressed](https://developer.android.com/reference/android/app/Activity#onBackPressed()) 函数，
在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreContextMenuClosed":{"name":"### onPreContextMenuClosed(params, menu)","description":"对应原生 Activity [onContextMenuClosed](https://developer.android.com/reference/android/app/Activity#onContextMenuClosed(android.view.Menu)) 函数，
在super方法之前调用","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| menu | Menu | 是 | - | - | 引发上下文菜单关闭事件的菜单。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreCreateContextMenu":{"name":"### onPreCreateContextMenu(params, menu, v, menuInfo)","description":"对应原生 Activity [onCreateContextMenu](https://developer.android.com/reference/android/app/Activity#onCreateContextMenu(android.view.ContextMenu,%20android.view.View,%20android.view.ContextMenu.ContextMenuInfo)) 函数，
在 super 方法之前调用，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| menu | ContextMenu | 是 | - | - | 要创建的上下文菜单。 |\n| v | View | 是 | - | - | 引发上下文菜单的视图。 |\n| menuInfo | ContextMenu.ContextMenuInfo \\| null | 否 | - | - | 与上下文菜单关联的上下文菜单信息，如果没有则为 null。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreOptionsMenuClosed":{"name":"### onPreOptionsMenuClosed(params, menu)","description":"对应原生 Activity [onOptionsMenuClosed](https://developer.android.com/reference/android/app/Activity#onOptionsMenuClosed(android.view.Menu)) 函数，
在 super 方法之前调用，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| menu | Menu | 是 | - | - | 被关闭的选项菜单。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPrePrepareNavigateUpTaskStack":{"name":"### onPrePrepareNavigateUpTaskStack(params, builder)","description":"对应原生 Activity [onPrepareNavigateUpTaskStack](https://developer.android.com/reference/android/app/Activity#onPrepareNavigateUpTaskStack(android.app.TaskStackBuilder)) 函数，
在 super 方法之前调用，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| builder | TaskStackBuilder | 是 | - | - | 用于构建向上导航任务栈的 TaskStackBuilder 实例。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreProvideAssistData":{"name":"### onPreProvideAssistData(params, data)","description":"对应原生 Activity [onProvideAssistData](https://developer.android.com/reference/android/app/Activity#onProvideAssistData(android.os.Bundle)) 函数，
在 super 方法之前调用，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| data | Bundle | 是 | - | - | 辅助数据的捆绑包。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreProvideAssistContent":{"name":"### onPreProvideAssistContent(params, outContent)","description":"对应原生 Activity [onProvideAssistContent](https://developer.android.com/reference/android/app/Activity#onProvideAssistContent(android.app.assist.AssistContent)) 函数，
在 super 方法之前调用，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| outContent | AssistContent | 是 | - | - | 辅助内容的对象。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"}},"UniActivityComponentCallback":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UniActivityComponentCallback)","onConfigurationChanged":{"name":"### onConfigurationChanged(params, newConfig)","description":"对应原生 Activity [onConfigurationChanged](https://developer.android.com/reference/android/app/Activity#onConfigurationChanged(android.content.res.Configuration)) 函数，
当设备配置（如屏幕大小、方向、语言等）发生改变时调用。开发者可以通过重写此方法来处理配置更改事件。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这允许开发者在处理配置更改时访问特定的环境信息。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| newConfig | Configuration | 是 | - | - | 新的设备配置数据。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onLowMemory":{"name":"### onLowMemory(params)","description":"对应原生 Activity [onLowMemory](https://developer.android.com/reference/android/app/Activity#onLowMemory()) 函数，
当系统运行在低内存环境下时调用。在这种情况下，开发者应当清除不必要的资源以帮助系统回收内存，减轻内存压力。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这提供了一个机会，让开发者能够在应用面临低内存情况时执行特定逻辑。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onTrimMemory":{"name":"### onTrimMemory(params, level)","description":"对应原生 Activity [onTrimMemory](https://developer.android.com/reference/android/app/Activity#onTrimMemory(int)) 函数，
当系统决定当前进程需要缩减内存使用时调用。开发者可以根据传递的内存级别清除不必要的资源以帮助系统管理内存。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这使得开发者能够基于应用的当前状态适当地响应内存清理需求。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| level | Int | 是 | - | - | 提供了当前内存清理级别的指示，开发者可以根据这个级别确定清理资源的紧迫性。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreConfigurationChanged":{"name":"### onPreConfigurationChanged(params, newConfig)","description":"该方法是对原生 Activity [onConfigurationChanged](https://developer.android.com/reference/android/app/Activity#onConfigurationChanged(android.content.res.Configuration)) 函数的扩展，
在 super 方法之前调用，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这为开发者提供了一个机会，让他们能够在配置更改生效之前对其进行预处理。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| newConfig | Configuration | 是 | - | - | 提供了新的设备配置信息，允许开发者根据这些信息调整应用行为。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreLowMemory":{"name":"### onPreLowMemory(params)","description":"此方法在 Activity 的 [onLowMemory](https://developer.android.com/reference/android/app/Activity#onLowMemory()) 方法被触发之前调用，
允许开发者在系统通知内存不足之前执行自定义逻辑。这可以用于积极地释放资源或减少内存使用，以避免应用被系统杀死。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。它们可以被用来做出更加上下文相关的响应。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreTrimMemory":{"name":"### onPreTrimMemory(params, level)","description":"此方法在 Activity 的 [onTrimMemory](https://developer.android.com/reference/android/app/Activity#onTrimMemory(int)) 方法被触发之前调用，
允许开发者在系统建议应用减少内存使用之前预先采取措施。这里的处理可以根据传递的内存级别清除缓存或其他不必要的资源。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。使用这些信息，可以选择性地进行内存优化。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| level | Int | 是 | - | - | 系统传递的当前内存清理级别的枚举值。开发者可以基于这个级别来调整他们的内存管理策略。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"}},"UniActivityKeyEventCallback":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UniActivityKeyEventCallback)","onKeyDown":{"name":"### onKeyDown(params, keyCode, event)","description":"此方法对应 Android Activity 的 [onKeyDown](https://developer.android.com/reference/android/app/Activity#onKeyDown(int,%20android.view.KeyEvent)) 函数，
在用户按下键盘键（例如返回键、菜单键等）时调用。可以用于自定义按键事件的响应逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这些参数为开发者提供了当前活动上下文以及任何先前操作的结果。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| keyCode | Int | 是 | - | - | 表明被按下的键的键码。 |\n| event | KeyEvent \\| null | 否 | - | - | 提供了关于按键事件的详细信息，包括按键的动作和代码。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onKeyLongPress":{"name":"### onKeyLongPress(params, keyCode, event)","description":"此方法对应 Android Activity 的 [onKeyLongPress](https://developer.android.com/reference/android/app/Activity#onKeyLongPress(int,%20android.view.KeyEvent)) 函数，
在用户长按键盘键时调用。这通常用于执行按键的二级功能。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这样，开发者可以利用设置的返回参数执行上下文相关的操作。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| keyCode | Int | 是 | - | - | 表明长按的键的键码。 |\n| event | KeyEvent \\| null | 否 | - | - | 提供关于长按键事件的额外信息，允许开发者根据需要来响应事件。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onKeyUp":{"name":"### onKeyUp(params, keyCode, event)","description":"此方法对应 Android Activity 的 [onKeyUp](https://developer.android.com/reference/android/app/Activity#onKeyUp(int,%20android.view.KeyEvent)) 函数，
在用户松开键盘键时调用。可以用于处理按键抬起事件。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这些参数为开发者提供当前上下文及函数调用的相关结果。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| keyCode | Int | 是 | - | - | 表示松开的键的键码。 |\n| event | KeyEvent \\| null | 否 | - | - | 提供了关于按键事件的详细信息，包含按键的动作和代码等。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onKeyMultiple":{"name":"### onKeyMultiple(params, keyCode, repeatCount, event)","description":"此方法对应 Android Activity 的 [onKeyMultiple](https://developer.android.com/reference/android/app/Activity#onKeyMultiple(int,%20int,%20android.view.KeyEvent)) 函数，
在用户进行多个按键事件时调用（例如，当用户按住某个键时会连续触发此事件）。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。可以用来执行基于当前应用状态的操作。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| keyCode | Int | 是 | - | - | 表示重复按下的键的键码。 |\n| repeatCount | Int | 是 | - | - | 表明此键的重复次数。 |\n| event | KeyEvent \\| null | 否 | - | - | 提供按键事件的详细信息。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreKeyDown":{"name":"### onPreKeyDown(params, keyCode, event)","description":"在 Android Activity 的 [onKeyDown](https://developer.android.com/reference/android/app/Activity#onKeyDown(int,%20android.view.KeyEvent)) 方法触发之前调用，
允许开发者在标准按键处理流程之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。便于开发者获取上下文信息和返回的数据。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| keyCode | Int | 是 | - | - | 按下的键的键码。 |\n| event | KeyEvent \\| null | 否 | - | - | 提供按键事件的详细信息。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreKeyLongPress":{"name":"### onPreKeyLongPress(params, keyCode, event)","description":"在 Android Activity 的 [onKeyLongPress](https://developer.android.com/reference/android/app/Activity#onKeyLongPress(int,%20android.view.KeyEvent)) 方法触发之前调用，
允许开发者在标准长按处理流程之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。开发者可以利用这些返回值进行进一步处理。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| keyCode | Int | 是 | - | - | 长按的键的键码。 |\n| event | KeyEvent \\| null | 否 | - | - | 提供长按键事件的详细信息。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreKeyUp":{"name":"### onPreKeyUp(params, keyCode, event)","description":"在 Android Activity 的 [onKeyUp](https://developer.android.com/reference/android/app/Activity#onKeyUp(int,%20android.view.KeyEvent)) 方法触发之前调用，
允许开发者在标准按键抬起处理流程之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。便于开发者获取和处理返回的数据。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| keyCode | Int | 是 | - | - | 松开的键的键码。 |\n| event | KeyEvent \\| null | 否 | - | - | 提供按键抬起事件的详细信息。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreKeyMultiple":{"name":"### onPreKeyMultiple(params, keyCode, repeatCount, event)","description":"在 Android Activity 的 [onKeyMultiple](https://developer.android.com/reference/android/app/Activity#onKeyMultiple(int,%20int,%20android.view.KeyEvent)) 方法触发之前调用，
允许开发者在处理多个按键事件之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。开发者可以根据这些返回值对按键事件进行处理。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| keyCode | Int | 是 | - | - | 表示触发多次的键的键码。 |\n| repeatCount | Int | 是 | - | - | 按键重复的次数。 |\n| event | KeyEvent \\| null | 否 | - | - | 提供多个按键事件的详细信息。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"}},"UniActivityLifeCycleCallback":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UniActivityLifeCycleCallback)","onCreate":{"name":"### onCreate(params, savedInstanceState)","description":"此方法对应 Android Activity 的 [onCreate](https://developer.android.com/reference/android/app/Activity#onCreate(android.os.Bundle)) 函数，
当Activity正在被创建时调用。这个回调提供了一种方法来执行任何初始化——创建视图、绑定数据等操作。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值，这些参数为开发者提供了当前上下文及函数调用的相关结果。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| savedInstanceState | Bundle \\| null | 否 | - | - | 如果Activity在之前被销毁，现在正在重新创建，这个Bundle将包含上次保存的状态数据。如果Activity是首次创建，则为null。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreCreate":{"name":"### onPreCreate(params, savedInstanceState)","description":"在 Android Activity 的 [onCreate](https://developer.android.com/reference/android/app/Activity#onCreate(android.os.Bundle)) 方法触发之前调用，
允许开发者在 Activity 创建之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这些参数为开发者提供了当前的上下文信息和方法调用的结果。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| savedInstanceState | Bundle \\| null | 否 | - | - | 如果 Activity 正在重新创建，则此参数包含之前保存的状态信息。 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onStart":{"name":"### onStart(params)","description":"对应原生 Activity 的 [onStart](https://developer.android.com/reference/android/app/Activity#onStart()) 函数，当Activity即将对用户可见时调用。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreStart":{"name":"### onPreStart(params)","description":"在 Android Activity 的 [onStart](https://developer.android.com/reference/android/app/Activity#onStart()) 方法触发之前调用，
允许开发者在 Activity 开始之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这些参数为开发者提供了进行操作所需的上下文信息。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onRestart":{"name":"### onRestart(params)","description":"对应原生 Activity 的 [onRestart](https://developer.android.com/reference/android/app/Activity#onRestart()) 函数，当Activity在停止后重新启动前调用。
注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数,包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreRestart":{"name":"### onPreRestart(params)","description":"对应原生 Activity 的 [onRestart](https://developer.android.com/reference/android/app/Activity#onRestart()) 函数，在super方法之前调用。此为在 Activity 重启前额外的准备步骤，提供了自定义操作的机会。
在 super 方法之前调用，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onResume":{"name":"### onResume(params)","description":"对应原生 Activity 的 [onResume](https://developer.android.com/reference/android/app/Activity#onResume()) 函数，在 Activity 准备和用户进行交互时调用。此时 Activity 处于运行状态的顶层。
注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreResume":{"name":"### onPreResume(params)","description":"在 Android Activity 的 [onResume](https://developer.android.com/reference/android/app/Activity#onResume()) 方法触发之前调用，
允许开发者在 Activity 恢复之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。借助这些参数，开发者可以对 Activity 的恢复行为进行定制。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPause":{"name":"### onPause(params)","description":"对应原生 Activity 的 [onPause](https://developer.android.com/reference/android/app/Activity#onPause()) 函数，当 Activity 开始进入不活动状态（即用户即将离开此 Activity）时调用。此时应当暂停正在进行的操作和更新 UI 数据。
注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPrePause":{"name":"### onPrePause(params)","description":"在 Android Activity 的 [onPause](https://developer.android.com/reference/android/app/Activity#onPause()) 方法触发之前调用，
允许开发者在 Activity 暂停之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这些参数提供了进行必要操作所需的上下文。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onStop":{"name":"### onStop(params)","description":"对应原生 Activity 的 [onStop](https://developer.android.com/reference/android/app/Activity#onStop()) 函数，在 Activity 即将停止时被调用，这通常是因为 Activity 即将被销毁，或因为用户切换到了另一个 Activity。在此阶段，应保存数据或进行清理工作。
注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreStop":{"name":"### onPreStop(params)","description":"在 Android Activity 的 [onStop](https://developer.android.com/reference/android/app/Activity#onStop()) 方法触发之前调用，
允许开发者在 Activity 停止之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。利用这些返回参数，开发者可以优化 Activity 的停止过程。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onDestroy":{"name":"### onDestroy(params)","description":"在 Android Activity 的 [onDestroy](https://developer.android.com/reference/android/app/Activity#onDestroy()) 方法触发时调用，
允许开发者在 Activity 销毁之前执行自定义逻辑或清理资源。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这些参数为开发者提供了当前的上下文信息和方法调用的结果。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreDestroy":{"name":"### onPreDestroy(params)","description":"在 Android Activity 的 [onDestroy](https://developer.android.com/reference/android/app/Activity#onDestroy()) 方法触发之前调用，
允许开发者在 Activity 销毁之前执行自定义逻辑。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值。这为开发者提供了一个机会，在 Activity 销毁之前做必要的资源释放与保存。 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"}},"UniActivityWindowCallback":{"tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=uts.platformObject.UniActivityWindowCallback)","onDetachedFromWindow":{"name":"### onDetachedFromWindow(params)","description":"对应原生 Activity 的 [onDetachedFromWindow](https://developer.android.com/reference/android/view/View#onDetachedFromWindow()) 函数，当 Activity 的窗口从窗口管理器中移除时调用。这是进行最后清理的好时机。
注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onContentChanged":{"name":"### onContentChanged(params)","description":"对应原生 Activity 的 [onContentChanged](https://developer.android.com/reference/android/app/Activity#onContentChanged()) 函数，当 Activity 的内容视图更改时调用。这可以作为响应内容更改并更新 UI 的适当时机。
注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onWindowAttributesChanged":{"name":"### onWindowAttributesChanged(params, attrs)","description":"对应原生 Activity 的 [onWindowAttributesChanged](https://developer.android.com/reference/android/view/Window.Callback#onWindowAttributesChanged(android.view.WindowManager.LayoutParams)) 函数，当当前窗口属性更改时调用，如大小、透明度等。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 attrs 为窗口参数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| attrs | WindowManager.LayoutParams | 是 | - | - | 新的窗口属性 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onWindowFocusChanged":{"name":"### onWindowFocusChanged(params, hasFocus)","description":"对应原生 Activity 的 [onWindowFocusChanged](https://developer.android.com/reference/android/app/Activity#onWindowFocusChanged(boolean)) 函数，当 Activity 的窗口焦点发生变化时调用，如获得或失去焦点。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 hasFocus 指示窗口是否获得了焦点。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| hasFocus | Boolean | 是 | - | - | 窗口是否获得了焦点 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onAttachedToWindow":{"name":"### onAttachedToWindow(params)","description":"对应原生 Activity 的 [onAttachedToWindow](https://developer.android.com/reference/android/view/View#onAttachedToWindow()) 函数，当 Activity 的窗口被添加到窗口管理器时调用。这标志着 Activity 可以开始与用户交互。
注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPanelClosed":{"name":"### onPanelClosed(params, featureId, menu)","description":"对应原生 Activity 的 [onPanelClosed](https://developer.android.com/reference/android/app/Activity#onPanelClosed(int,%20android.view.Menu)) 函数，当菜单面板被关闭时调用，可以在这里做一些清理工作。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 featureId 为面板编号，第三个参数 menu 为面板的菜单。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| featureId | Int | 是 | - | - | 面板编号 |\n| menu | Menu | 是 | - | - | 面板的菜单 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onSearchRequested":{"name":"### onSearchRequested(params)","description":"对应原生 Activity 的 [onSearchRequested](https://developer.android.com/reference/android/app/Activity#onSearchRequested()) 函数，当用户请求搜索操作时调用。您可以在这里启动一个搜索界面。
注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onWindowStartingActionMode":{"name":"### onWindowStartingActionMode(params, callback)","description":"对应原生 Activity 的 [onWindowStartingActionMode](https://developer.android.com/reference/android/app/Activity#onWindowStartingActionMode(android.view.ActionMode.Callback)) 函数，当窗口开始进入操作模式时调用，如选择文本操作。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 callback 为操作模式回调。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| callback | ActionMode.Callback \\| null | 否 | - | - | 操作模式的回调 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onWindowStartingActionMode_1":{"name":"### onWindowStartingActionMode(params, callback, type)","description":"对应原生 Activity 的 [onWindowStartingActionMode](https://developer.android.com/reference/android/app/Activity#onWindowStartingActionMode(android.view.ActionMode.Callback,%20int)) 函数，使用特定类型时调用。例如，浮动或类型化的操作模式。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 callback 为操作模式回调，第三个参数 type 为操作模式类型。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| callback | ActionMode.Callback \\| null | 否 | - | - | 操作模式的回调 |\n| type | Int | 是 | - | - | 操作模式的类型 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onActionModeFinished":{"name":"### onActionModeFinished(params, mode)","description":"对应原生 Activity 的 [onActionModeFinished](https://developer.android.com/reference/android/app/Activity#onActionModeFinished(android.view.ActionMode)) 函数，当操作模式结束时调用。可以在此处执行清理工作。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 mode 为结束的操作模式。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| mode | ActionMode \\| null | 否 | - | - | 结束的操作模式 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onActionModeStarted":{"name":"### onActionModeStarted(params, mode)","description":"对应原生 Activity 的 [onActionModeStarted](https://developer.android.com/reference/android/app/Activity#onActionModeStarted(android.view.ActionMode)) 函数，当操作模式开始时调用。可以在此处进行初始化工作。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 mode 为开始的操作模式。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| mode | ActionMode \\| null | 否 | - | - | 开始的操作模式 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onProvideKeyboardShortcuts":{"name":"### onProvideKeyboardShortcuts(params, data, menu, deviceId)","description":"对应原生 Activity 的 [onProvideKeyboardShortcuts](https://developer.android.com/reference/android/app/Activity#onProvideKeyboardShortcuts(java.util.List,%20android.view.Menu,%20int)) 函数，当用户请求显示键盘快捷方式帮助时调用。可以在此处提供快捷方式信息。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 data 为键盘快捷方式群组的列表，第三个参数 menu 为相关联的菜单（如果有），第四个参数 deviceId 为请求快捷方式的设备ID。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| data | MutableList\\ \\| null | 否 | - | - | 键盘快捷方式群组的列表 |\n| menu | Menu \\| null | 否 | - | - | 相关联的菜单 |\n| deviceId | Int | 是 | - | - | 设备ID | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPointerCaptureChanged":{"name":"### onPointerCaptureChanged(params, hasCapture)","description":"对应原生 Activity 的 [onPointerCaptureChanged](https://developer.android.com/reference/android/app/Activity#onPointerCaptureChanged(boolean)) 函数，当指针捕获状态更改时调用。可以在此处更新 UI 或状态来响应捕获状态的变化。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 hasCapture 指示是否启用了指针捕获。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数, 包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| hasCapture | Boolean | 是 | - | - | 是否启用了指针捕获 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreDetachedFromWindow":{"name":"### onPreDetachedFromWindow(params)","description":"对应原生 Activity 的 [onDetachedFromWindow](https://developer.android.com/reference/android/view/View#onDetachedFromWindow()) 函数，此方法在super.onDetachedFromWindow() 调用之前被调用，用于处理 Activity 的窗口从窗口管理器中即将移除前的逻辑。
注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreContentChanged":{"name":"### onPreContentChanged(params)","description":"对应原生 Activity 的 [onContentChanged](https://developer.android.com/reference/android/app/Activity#onContentChanged()) 函数，此方法在super.onContentChanged() 调用之前被调用，用于处理 Activity 内容更改前的逻辑。
注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreWindowAttributesChanged":{"name":"### onPreWindowAttributesChanged(params, attrs)","description":"对应原生 Activity 的 [onWindowAttributesChanged](https://developer.android.com/reference/android/view/Window.Callback#onWindowAttributesChanged(android.view.WindowManager.LayoutParams)) 函数，此方法在super.onWindowAttributesChanged() 调用之前被调用，用于处理窗口属性更改前的逻辑。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 attrs 为窗口属性参数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| attrs | WindowManager.LayoutParams | 是 | - | - | 窗口属性 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreWindowFocusChanged":{"name":"### onPreWindowFocusChanged(params, hasFocus)","description":"对应原生 Activity 的 [onWindowFocusChanged](https://developer.android.com/reference/android/app/Activity#onWindowFocusChanged(boolean)) 函数，此方法在super.onWindowFocusChanged() 调用之前被调用，用于处理窗口焦点更改前的逻辑。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 hasFocus 表示是否获得焦点。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| hasFocus | Boolean | 是 | - | - | 窗口是否获得焦点 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreAttachedToWindow":{"name":"### onPreAttachedToWindow(params)","description":"对应原生 Activity 的 [onAttachedToWindow](https://developer.android.com/reference/android/view/View#onAttachedToWindow()) 函数，此方法在super.onAttachedToWindow() 调用之前被调用，用于处理窗口附加到窗口管理器前的逻辑。
注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPrePanelClosed":{"name":"### onPrePanelClosed(params, featureId, menu)","description":"对应原生 Activity 的 [onPanelClosed](https://developer.android.com/reference/android/app/Activity#onPanelClosed(int,%20android.view.Menu)) 函数，此方法在super.onPanelClosed() 调用之前被调用，用于处理面板关闭前的逻辑。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 featureId 表示面板的特征标识，第三个参数 menu 表示关闭的面板的菜单。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| featureId | Int | 是 | - | - | 面板的特征标识 |\n| menu | Menu | 是 | - | - | 面板的菜单 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreSearchRequested":{"name":"### onPreSearchRequested(params)","description":"对应原生 Activity 的 [onSearchRequested](https://developer.android.com/reference/android/app/Activity#onSearchRequested()) 函数，此方法在super.onSearchRequested() 调用之前被调用，用于处理搜索请求前的逻辑。
注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreWindowStartingActionMode":{"name":"### onPreWindowStartingActionMode(params, callback)","description":"对应原生 Activity 的 [onWindowStartingActionMode](https://developer.android.com/reference/android/app/Activity#onWindowStartingActionMode(android.view.ActionMode.Callback)) 函数，此方法在super.onWindowStartingActionMode() 调用之前被调用，用于处理窗口开始操作模式前的逻辑。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 callback 为操作模式的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| callback | ActionMode.Callback \\| null | 否 | - | - | 操作模式的回调函数 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreWindowStartingActionMode_1":{"name":"### onPreWindowStartingActionMode(params, callback)","description":"对应原生 Activity 的 [onWindowStartingActionMode](https://developer.android.com/reference/android/app/Activity#onWindowStartingActionMode(android.view.ActionMode.Callback)) 函数，此方法在super.onWindowStartingActionMode() 调用之前被调用，用于处理窗口开始操作模式前的逻辑。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 callback 为操作模式的回调函数。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| callback | ActionMode.Callback \\| null | 否 | - | - | 操作模式的回调函数 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreWindowStartingActionMode_2":{"name":"### onPreWindowStartingActionMode(params, callback, type)","description":"对应原生 Activity 的 [onWindowStartingActionMode](https://developer.android.com/reference/android/app/Activity#onWindowStartingActionMode(android.view.ActionMode.Callback,%20int)) 函数，此方法在super.onWindowStartingActionMode() 调用之前被调用，用于处理特定类型操作模式开始前的逻辑。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 callback 为操作模式的回调函数，第三个参数 type 为操作模式的类型。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| callback | ActionMode.Callback \\| null | 否 | - | - | 操作模式的回调函数 |\n| type | Int | 是 | - | - | 操作模式的类型 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreActionModeFinished":{"name":"### onPreActionModeFinished(params, mode)","description":"对应原生 Activity 的 [onActionModeFinished](https://developer.android.com/reference/android/app/Activity#onActionModeFinished(android.view.ActionMode)) 函数，此方法在super.onActionModeFinished() 调用之前被调用，用于处理操作模式结束前的逻辑。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 mode 表示结束的操作模式。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| mode | ActionMode \\| null | 否 | - | - | 结束的操作模式 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreActionModeStarted":{"name":"### onPreActionModeStarted(params, mode)","description":"对应原生 Activity 的 [onActionModeStarted](https://developer.android.com/reference/android/app/Activity#onActionModeStarted(android.view.ActionMode)) 函数，此方法在super.onActionModeStarted() 调用之前被调用，用于处理操作模式开始前的逻辑。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 mode 表示开始的操作模式。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| mode | ActionMode \\| null | 否 | - | - | 开始的操作模式 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPreProvideKeyboardShortcuts":{"name":"### onPreProvideKeyboardShortcuts(params, data, menu, deviceId)","description":"对应原生 Activity 的 [onProvideKeyboardShortcuts](https://developer.android.com/reference/android/app/Activity#onProvideKeyboardShortcuts(java.util.List,%20android.view.Menu,%20int)) 函数，此方法在super.onProvideKeyboardShortcuts() 调用之前被调用，用于处理提供键盘快捷方式前的逻辑。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 data 为键盘快捷键列表，第三个参数 menu 为菜单（如果有），第四个参数 deviceId 为设备ID。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| data | MutableList\\ \\| null | 否 | - | - | 键盘快捷键列表 |\n| menu | Menu \\| null | 否 | - | - | 菜单 |\n| deviceId | Int | 是 | - | - | 设备ID | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"onPrePointerCaptureChanged":{"name":"### onPrePointerCaptureChanged(params, hasCapture)","description":"对应原生 Activity 的 [onPointerCaptureChanged](https://developer.android.com/reference/android/app/Activity#onPointerCaptureChanged(boolean)) 函数，此方法在super.onPointerCaptureChanged() 调用之前被调用，用于处理指针捕获状态改变前的逻辑。
注意第一个参数为自定义参数 UniActivityParams，第二个参数 hasCapture 表示是否捕获了输入指针。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| hasCapture | Boolean | 是 | - | - | 是否捕获了输入指针 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"dispatchKeyEvent":{"name":"### dispatchKeyEvent(params, event)","description":"对应原生 Activity 的 [dispatchKeyEvent](https://developer.android.com/reference/android/app/Activity#dispatchKeyEvent(android.view.KeyEvent)) 函数
注意第一个参数为自定义参数 UniActivityParams，第二个参数 event 为按键事件。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| event | KeyEvent \\| null | 否 | - | - | 按键事件 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"},"dispatchPreKeyEvent":{"name":"### dispatchPreKeyEvent(params, event)","description":"对应原生 Activity 的 [dispatchKeyEvent](https://developer.android.com/reference/android/app/Activity#dispatchKeyEvent(android.view.KeyEvent)) 函数，此方法在super.dispatchKeyEvent() 调用之前被调用，用于处理按键事件分发前的逻辑。
在super方法之前调用，注意第一个参数为自定义参数 UniActivityParams。","param":"**参数** \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| params | **UniActivityParams** | 是 | - | - | 统一返回参数，包括页面路由地址与方法返回值 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| pageRoute | string | 是 | - | | 页面路由地址 |\n@| result | any \\| null | 否 | - | | 如果对应的方法有返回值，会将返回值赋给result，默认null |\n| event | KeyEvent \\| null | 否 | - | - | 按键事件 | \n","returnValue":"**返回值** \n\n| 类型 |\n| :- |\n| void | \n","compatibility":"**兼容性** \n\n| Android uni-app x | iOS uni-app x | web uni-app x | Android uni-app | iOS uni-app | web uni-app |\n| :- | :- | :- | :- | :- | :- |\n| 4.18 | x | - | x | x | - |\n","itemType":"method"}}} \ No newline at end of file diff --git a/docs/.vuepress/utils/utsUnicloudApiJson.json b/docs/.vuepress/utils/utsUnicloudApiJson.json index 2411b31bc238ffdee4e9d29928a5b268672f5d50..037e00f9500922e0b1ba589becf0e116e2e16b73 100644 --- a/docs/.vuepress/utils/utsUnicloudApiJson.json +++ b/docs/.vuepress/utils/utsUnicloudApiJson.json @@ -1 +1 @@ -{"uniCloud_props":{"name":"# uniCloud","description":"","param":"## 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| config | **UniCloudInitOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| provider | string | 是 | - | - | 服务商，目前支持 aliyun、tencent、alipay |\n@| spaceName | string | 否 | - | - | 服务空间名 |\n@| spaceId | string | 是 | - | - | 服务空间id |\n@| clientSecret | string | 否 | - | - | 阿里云clientSecret |\n@| endpoint | string | 否 | - | - | 阿里云endpoint |\n@| spaceAppId | string | 否 | - | - | 支付宝小程序云spaceAppId |\n@| accessKey | string | 否 | - | - | 支付宝小程序云accessKey |\n@| secretKey | string | 否 | - | - | 支付宝小程序云secretKey |\n| mixinDatacom | any | 是 | - | - | - | \n","returnValue":"","compatibility":"","tutorial":""},"callFunction":{"name":"## callFunction(options) @callfunction","description":"请求云函数","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UniCloudCallFunctionOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| name | string ([string.CloudFunctionString](/uts/data-type.md#ide-string)) | 是 | - | - | 云函数名 |\n@| data | any | 否 | - | - | 云函数参数 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudCallFunctionResult\\](#unicloudcallfunctionresult-values)> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| result | T | 是 | - | - | 云函数返回结果 |\n@| requestId | string | 否 | - | - | 云函数请求id | \n","compatibility":"### callFunction 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-call-function.callFunction)\n"},"unicloud-call-function":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/unicloud-call-function/unicloud-call-function.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud-call-function/unicloud-call-function\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: '请求云函数',\n callFunctionResult: {},\n callFunctionError: {},\n genericDemoShowMessage: '',\n isUniTest: false\n }\n },\n onLoad() {\n },\n onUnload() {\n if (this.isUniTest) {\n uni.hideToast()\n }\n },\n methods: {\n notify(content : string, title : string) {\n if (!this.isUniTest) {\n uni.showModal({\n title,\n content,\n showCancel: false\n })\n } else {\n console.log(title, content)\n }\n },\n async callFunctionWithGeneric() : Promise {\n type EchoCfResult = {\n showMessage: string\n }\n uni.showLoading({\n title: '加载中...'\n })\n await uniCloud.callFunction({\n name: 'echo-cf',\n data: {\n num: 1,\n str: 'ABC'\n }\n }).then(res => {\n const result = res.result\n uni.hideLoading()\n this.genericDemoShowMessage = result.showMessage\n this.notify(result.showMessage, '提示')\n }).catch((err : any | null) => {\n const error = err as UniCloudError\n this.callFunctionError = {\n errCode: error.errCode,\n errMsg: error.errMsg\n }\n uni.hideLoading()\n this.notify(error.errMsg, '错误')\n })\n },\n async callFunction() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n await uniCloud.callFunction({\n name: 'echo-cf',\n data: {\n num: 1,\n str: 'ABC'\n }\n }).then(res => {\n const result = res.result\n this.callFunctionResult = result\n console.log(JSON.stringify(result))\n uni.hideLoading()\n this.notify(result['showMessage'] as string, '提示')\n }).catch((err : any | null) => {\n const error = err as UniCloudError\n this.callFunctionError = {\n errCode: error.errCode,\n errMsg: error.errMsg\n }\n uni.hideLoading()\n this.notify(error.errMsg, '错误')\n })\n }\n }\n }\n\n```\n:::"},"importObject":{"name":"## importObject(objectName, options?) @importobject","description":"引用云对象","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| objectName | string ([string.CloudObjectString](/uts/data-type.md#ide-string)) | 是 | - | - | - |\n| options | **UniCloudImportObjectOptions** | 否 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| customUI | boolean \\| null | 否 | - | - | 是否移除自动展示的ui |\n@| loadingOptions | **UniCloudImportObjectLoadingOptions** \\| null | 否 | - | - | loading界面配置 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| title | string \\| null | 否 | - | - | 加载框标题 |\n@@| mask | boolean \\| null | 否 | - | - | 加载框是否显示mask |\n@| errorOptions | **UniCloudImportObjectErrorOptions** \\| null | 否 | - | - | 错误提示配置 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| type | string \\| null | 否 | - | - | 错误提示类型，可以是modal或者toast |\n@@| retry | boolean \\| null | 否 | - | - | 是否显示重试按钮 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudCloudObjectCaller](#unicloudcloudobjectcaller-values) |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| _obj | [InternalUniCloudCloudObject](#internalunicloudcloudobject-values) | 是 | - | - | - |\n##### InternalUniCloudCloudObject 的方法 @internalunicloudcloudobject-values \n\n##### callMethod(methodName, args) @callmethod\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| methodName | string | 是 | - | - | - |\n| args | Array\\ | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\ |\n \n\n###### callMethod 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### UniCloudCloudObjectCaller 的方法 @unicloudcloudobjectcaller-values \n\n#### _getArgs(args?) @_getargs\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| args | Array\\ | 否 | - | - | - | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Array\\ |\n \n\n##### _getArgs 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n","compatibility":"### importObject 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-import-object.importObject)\n"},"unicloud-import-object":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/unicloud-import-object/unicloud-import-object.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud-import-object/unicloud-import-object\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: '请求云对象',\n todoTitle: '学习编程',\n todoContent: '熟悉uts语法',\n returnTodoTitle: '',\n returnTodoContent: '',\n genericDemoReturnTodoTitle: '',\n genericDemoReturnTodoContent: '',\n failErrCode: '',\n failNumberErrCode: 0,\n successErrCode: -1,\n isUniTest: false\n }\n },\n methods: {\n notify(content : string, title : string) {\n if (!this.isUniTest) {\n uni.showModal({\n title,\n content,\n showCancel: false\n })\n } else {\n console.log(title, content)\n }\n },\n async addTodo() : Promise {\n const todo = uniCloud.importObject('todo', {\n customUI: this.isUniTest\n })\n const title = this.todoTitle\n const content = this.todoContent\n await todo.add(title, content).then((res : UTSJSONObject) => {\n this.returnTodoTitle = res['title'] as string\n this.returnTodoContent = res['content'] as string\n this.notify(res['showMessage'] as string, '提示')\n }).catch((err : any | null) => {\n console.log(err)\n const error = err as UniCloudError\n console.error(error)\n })\n },\n async addTodoWithGeneric() : Promise {\n type AddTodoResult = {\n title: string,\n content: string,\n showMessage: string\n }\n const todo = uniCloud.importObject('todo', {\n customUI: this.isUniTest\n })\n const title = this.todoTitle\n const content = this.todoContent\n await todo.add(title, content).then((res : AddTodoResult) => {\n this.genericDemoReturnTodoTitle = res.title\n this.genericDemoReturnTodoContent = res.content\n this.notify(res.showMessage, '提示')\n }).catch((err : any | null) => {\n console.log(err)\n const error = err as UniCloudError\n console.error(error)\n })\n },\n async randomFail() : Promise {\n const todoObj = uniCloud.importObject('todo', {\n errorOptions: {\n retry: true\n }\n })\n await todoObj.randomFail().then((res : UTSJSONObject) => {\n this.notify(res['showMessage'] as string, '提示')\n }).catch((err : any | null) => {\n const error = err as UniCloudError\n console.error(error)\n })\n },\n async fail() : Promise {\n const todo = uniCloud.importObject('todo', {\n customUI: this.isUniTest\n })\n await todo.fail().then((res : UTSJSONObject) => {\n this.notify('todo.fail应调用失败，此处错误的触发了成功回调', '错误')\n console.log('todo.fail: ', res);\n }).catch((err : any | null) => {\n const error = err as UniCloudError\n this.failErrCode = error.errCode as string\n console.error(error)\n })\n },\n async failWithNumberErrCode() : Promise {\n const todo = uniCloud.importObject('todo', {\n customUI: this.isUniTest\n })\n await todo.failWithNumberErrCode().then((res : UTSJSONObject) => {\n this.notify('todo.fail应调用失败，此处错误的触发了成功回调', '错误')\n console.log('todo.fail: ', res);\n }).catch((err : any | null) => {\n const error = err as UniCloudError\n this.failNumberErrCode = error.errCode as number\n console.error(error)\n })\n },\n async success() : Promise {\n const todo = uniCloud.importObject('todo', {\n customUI: this.isUniTest\n })\n await todo.success().then((res : UTSJSONObject) => {\n this.successErrCode = res['errCode'] as number\n this.notify(res['showMessage'] as string, '提示')\n }).catch((err : any | null) => {\n const error = err as UniCloudError\n console.error(error)\n })\n }\n }\n }\n\n```\n:::"},"uploadFile":{"name":"## uploadFile(options) @uploadfile","description":"上传文件到云存储","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [UniCloudUploadFileOptions](#uniclouduploadfileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | string | 是 | - | - | 文件路径 |\n@| cloudPath | string | 是 | - | - | 云端路径 |\n@| cloudPathAsRealPath | boolean | 否 | - | - | 是否以云端路径是否为真实路径保存上传的文件 | \n\n#### UniCloudUploadFileOptions 的方法 @uniclouduploadfileoptions-values \n\n#### onUploadProgress(options) @onuploadprogress\n\n上传进度回调\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UniCloudUploadProgress** | 是 | - | - | 上传进度回调参数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| loaded | number | 是 | - | - | 已上传大小 |\n@| total | number | 是 | - | - | 总大小 | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n##### onUploadProgress 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudUploadFileResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | string | 是 | - | - | 文件路径 |\n@| fileID | string | 是 | - | - | 文件id | \n","compatibility":"### uploadFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-file-api.upload-file)\n"},"getTempFileURL":{"name":"## getTempFileURL(options) @gettempfileurl","description":"获取文件临时URL","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UniCloudGetTempFileURLOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fileList | Array\\ | 是 | - | - | 文件列表 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudGetTempFileURLResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fileList | Array\\<**UniCloudGetTempFileURLResultItem**\\> | 是 | - | - | 文件列表 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| fileID | string | 是 | - | - | 文件id |\n@@| tempFileURL | string | 是 | - | - | 文件临时url | \n","compatibility":"### getTempFileURL 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-file-api.choose-and-upload-file)\n"},"chooseAndUploadFile":{"name":"## chooseAndUploadFile(options) @chooseanduploadfile","description":"选择并上传文件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [UniCloudChooseAndUploadFileOptions](#unicloudchooseanduploadfileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| sourceType | Array\\ \\| null | 否 | - | - | |\n@| count | number \\| null | 否 | - | - | |\n@| sizeType | Array\\ \\| null | 否 | - | - | |\n@| extension | Array\\ \\| null | 否 | - | - | |\n@| compressed | boolean \\| null | 否 | - | - | |\n@| maxDuration | number \\| null | 否 | - | - | |\n@| camera | string \\| null | 否 | - | - | |\n@| crop | ChooseImageCropOptions \\| null | 否 | - | - | |\n@| type | string | 是 | - | - | - | \n\n#### UniCloudChooseAndUploadFileOptions 的方法 @unicloudchooseanduploadfileoptions-values \n\n#### onChooseFile(arg) @onchoosefile\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | **UniCloudChooseFileResult** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| tempFiles | Array\\<**UniCloudChooseFileItem**\\> | 是 | - | - | - |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| name | string | 是 | - | - | - |\n@@| path | string | 是 | - | - | - |\n@@| cloudPath | string | 是 | - | - | - |\n@@| cloudPathAsRealPath | boolean \\| null | 否 | - | - | |\n@@| url | string \\| null | 否 | - | - | |\n@@| errMsg | string \\| null | 否 | - | - | |\n@| tempFilePaths | Array\\ | 是 | - | - | - | \n\n##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| void \\| null | 否 |\n \n\n##### onChooseFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### onUploadProgress(arg) @onuploadprogress\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | **UniCloudChooseAndUploadFileProgressEvent** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| index | number | 是 | - | - | - |\n@| loaded | number | 是 | - | - | - |\n@| total | number | 是 | - | - | - |\n@| tempFilePath | string | 是 | - | - | - |\n@| tempFile | **UniCloudChooseFileItem** | 是 | - | - | - |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| name | string | 是 | - | - | - |\n@@| path | string | 是 | - | - | - |\n@@| cloudPath | string | 是 | - | - | - |\n@@| cloudPathAsRealPath | boolean \\| null | 否 | - | - | |\n@@| url | string \\| null | 否 | - | - | |\n@@| errMsg | string \\| null | 否 | - | - | | \n\n##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| void \\| null | 否 |\n \n\n##### onUploadProgress 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudChooseAndUploadFileResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| tempFiles | Array\\<**UniCloudChooseFileItem**\\> | 是 | - | - | - |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| name | string | 是 | - | - | - |\n@@| path | string | 是 | - | - | - |\n@@| cloudPath | string | 是 | - | - | - |\n@@| cloudPathAsRealPath | boolean \\| null | 否 | - | - | |\n@@| url | string \\| null | 否 | - | - | |\n@@| errMsg | string \\| null | 否 | - | - | |\n@| tempFilePaths | Array\\ | 是 | - | - | - | \n","compatibility":"### chooseAndUploadFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-file-api.getTempFileURL)\n"},"unicloud-file-api":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/unicloud-file-api/unicloud-file-api.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud-file-api/unicloud-file-api\n>Template\n```vue\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: '云存储'\n }\n },\n onLoad() {\n },\n onUnload() {\n },\n methods: {\n uploadFile: function () {\n uni.chooseImage({\n count: 1,\n success(res) : void {\n uni.showLoading({\n title: '上传中...'\n })\n const tempFilePath = res.tempFilePaths[0]\n uniCloud.uploadFile({\n filePath: tempFilePath,\n cloudPath: 'test.jpg'\n })\n .then(function (res) {\n uni.hideLoading()\n console.log(res)\n uni.showModal({\n content: '上传成功',\n showCancel: false\n });\n })\n .catch(function (err : any | null) {\n uni.hideLoading()\n const error = err as UniCloudError\n uni.showModal({\n content: '上传失败，' + error.errMsg,\n showCancel: false\n });\n })\n // .finally((_: number) : void => {\n // uni.hideLoading()\n // })\n },\n fail(err) : void {\n console.error('chooseImage fail: ', err)\n }\n })\n }\n }\n }\n\n```\n:::"},"databaseForJQL":{"name":"## databaseForJQL() @databaseforjql","description":"获取数据库操作实例","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [Database](#database-values) |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| command | any | 是 | - | - | - |\n@| Geo | any | 是 | - | - | - |\n#### Database 的方法 @database-values \n\n#### collection(args?) @collection\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| args | Array\\ | 否 | - | - | - | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [Collection](#collection-values) |\n\n##### Collection 的方法 @collection-values \n\n##### where(condition) @where\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| condition | any | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n\n##### UniCloudDBFilter 的方法 @uniclouddbfilter-values \n\n##### get(arg?) @get\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | any \\| null | 否 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBGetResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| data | Array\\ | 是 | - | - | etResult = { /** |\n@| count | number \\| null | 否 | - | - | JSONObject>;
/** |\n@| requestId | string | 否 | - | - | ber \\| null; / | \n\n###### get 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### count() @count\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBCountResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| total | number | 是 | - | - | ntResult = { /** |\n@| requestId | string | 否 | - | - | al: number; / | \n\n###### count 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### update(data) @update\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | any | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBUpdateResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| updated | number | 是 | - | - | teResult = { /** |\n@| requestId | string | 否 | - | - | ted: number; / | \n\n###### update 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### remove() @remove\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBRemoveResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| deleted | number | 是 | - | - | veResult = { /** |\n@| requestId | string | 否 | - | - | ted: number; / | \n\n###### remove 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### getTemp() @gettemp\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n###### getTemp 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### where(condition) @where\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| condition | any | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### where 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### doc(docId) @doc\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| docId | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### doc 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### field(filed) @field\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filed | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n\n##### UniCloudDBQuery 的方法 @uniclouddbquery-values \n\n##### get(arg?) @get\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | any \\| null | 否 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudDBGetResult](#uniclouddbgetresult-values)> |\n \n\n###### get 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### count() @count\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudDBCountResult](#uniclouddbcountresult-values)> |\n \n\n###### count 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### getTemp() @gettemp\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n###### getTemp 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### field(filed) @field\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filed | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### field 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### skip(num) @skip\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### skip 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### limit(num) @limit\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### limit 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### orderBy(order) @orderby\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| order | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### orderBy 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### groupBy(field) @groupby\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### groupBy 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### groupField(field) @groupfield\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### groupField 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### distinct(field) @distinct\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### distinct 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### geoNear(options) @geonear\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | any | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### geoNear 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n\n###### field 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### skip(num) @skip\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### skip 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### limit(num) @limit\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### limit 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### orderBy(order) @orderby\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| order | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### orderBy 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### groupBy(field) @groupby\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### groupBy 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### groupField(field) @groupfield\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### groupField 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### distinct(field) @distinct\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### distinct 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### geoNear(options) @geonear\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | any | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### geoNear 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n\n###### where 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### doc(docId) @doc\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| docId | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### doc 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### aggregate() @aggregate\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### aggregate 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### foreignKey(foreignKey) @foreignkey\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| foreignKey | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### foreignKey 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### add(data) @add\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | any | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBAddResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| id | string | 是 | - | - | ddResult = { /** |\n@| requestId | string | 否 | - | - | string; / | \n\n###### add 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### get(arg?) @get\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | any \\| null | 否 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudDBGetResult](#uniclouddbgetresult-values)> |\n \n\n###### get 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### count() @count\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudDBCountResult](#uniclouddbcountresult-values)> |\n \n\n###### count 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### getTemp() @gettemp\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n###### getTemp 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### field(filed) @field\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filed | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### field 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### skip(num) @skip\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### skip 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### limit(num) @limit\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### limit 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### orderBy(order) @orderby\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| order | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### orderBy 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n\n##### collection 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### multiSend(args?) @multisend\n合并查询请求\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| args | Array\\ | 否 | - | - | - | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBMultiSendResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| dataList | Array\\<**UniCloudDBMultiSendResultItem**\\> | 是 | - | - | SendResult = { |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| errCode | any | 是 | - | - | ResultItem = { /** 错误码，可 |\n@@| errMsg | string | 是 | - | - | errCode : any |\n@@| data | Array\\ | 否 | - | - | Msg : stri |\n@| requestId | string | 否 | - | - | ndResultItem[\\] | \n\n##### multiSend 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.16 | 4.11 | 4.0 |\n\n \n","compatibility":"### databaseForJQL 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.91，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-database.databaseForJQL)\n"},"unicloud-database":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/unicloud-database/unicloud-database.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud-database/unicloud-database\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: 'ClientDB',\n addId: '',\n batchAddIds: [] as Array,\n batchAddinserted: 0,\n updateUpdated: 0,\n getData: [] as Array,\n getWithCommandData: [] as Array,\n removeDeleted: 0,\n lookupData: [] as Array,\n multiSendSuccessCount: 0,\n isUniTest: false\n }\n },\n computed: {\n dataTag() : string {\n return this.isUniTest ? 'default-tag' + Date.now() : 'default-tag'\n }\n },\n methods: {\n notify(content : string, title : string) {\n if (!this.isUniTest) {\n uni.showModal({\n title,\n content,\n showCancel: false\n })\n } else {\n console.log(title, content)\n }\n },\n async dbAdd() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .add({\n num: 1,\n tag: this.dataTag,\n date: new Date()\n })\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.addId = res.id\n this.notify(`新增成功，id: ${res.id}`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbBatchAdd() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .add([{\n num: 2,\n tag: this.dataTag,\n }, {\n num: 3,\n tag: this.dataTag,\n }])\n .then((res) => {\n uni.hideLoading()\n console.log(res)\n console.log('JSON.stringify(res.inserted)', JSON.stringify(res.inserted))\n this.batchAddIds = res.ids\n this.batchAddinserted = res.inserted\n this.notify(`新增成功条数${res.inserted}, id列表: ${res.ids.join(',')}`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbGet() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .where(\n `tag == \"${this.dataTag}\"`\n )\n .field('num, tag')\n .orderBy('num desc')\n .skip(1)\n .limit(2)\n .get()\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.getData = res.data\n this.notify(`获取成功，取到了${res.data.length}条数据`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbGetWithCommand() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .where({\n num: db.command.gt(1),\n tag: this.dataTag\n })\n .field('num, tag')\n .orderBy('num desc')\n .skip(1)\n .limit(2)\n .get()\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.getWithCommandData = res.data\n this.notify(`获取成功，取到了${res.data.length}条数据`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbUpdate() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .where(\n `tag == \"${this.dataTag}\"`\n )\n .update({\n num: 4\n })\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.updateUpdated = res.updated\n this.notify(`更新成功，更新了${res.updated}条数据`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbRemove() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .where(\n `tag == \"${this.dataTag}\"`\n )\n .remove()\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.removeDeleted = res.deleted\n this.notify(`删除成功，删掉了${res.deleted}条数据`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbLookupInit() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('local')\n .where(`tag == \"${this.dataTag}\"`)\n .remove()\n .then(() : Promise => {\n return db.collection('foreign')\n .where(`tag == \"${this.dataTag}\"`)\n .remove()\n })\n .then(() : Promise => {\n return db.collection('local')\n .add([{\n id: \"local_1\",\n name: \"local_1_name\",\n tag: this.dataTag,\n foreign_id: \"foreign_1\"\n }, {\n id: \"local_2\",\n name: \"local_2_name\",\n tag: this.dataTag,\n foreign_id: \"foreign_2\"\n }])\n })\n .then(() : Promise => {\n return db.collection('foreign')\n .add([{\n id: \"foreign_1\",\n name: \"foreign_1_name\",\n tag: this.dataTag\n }, {\n id: \"foreign_2\",\n name: \"foreign_2_name\",\n tag: this.dataTag\n }])\n })\n .then((_) : void => {\n uni.hideLoading()\n this.notify('数据初始化成功', '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n console.error(err)\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbLookup() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n const local = db.collection('local')\n .where(`tag == \"${this.dataTag}\"`)\n .getTemp()\n const foreign = db.collection('foreign')\n .where(`tag == \"${this.dataTag}\"`)\n .getTemp()\n await db.collection(local, foreign)\n .get()\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.lookupData = res.data\n this.notify(`联表查询成功，取到了${res.data.length}条数据`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\r\n dbMultiSend() {\r\n const db = uniCloud.databaseForJQL()\r\n const temp1 = db.collection('type')\r\n .where(\r\n 'tag == \"default-tag\"'\r\n ).getTemp()\r\n const temp2 = db.collection('type')\r\n .where(\r\n 'tag == \"default-tag\"'\r\n ).getTemp()\r\n db.multiSend(temp1, temp2)\r\n .then(res => {\r\n uni.hideLoading()\n let successCount = 0\n for (let i = 0; i < res.dataList.length; i++) {\n const item = res.dataList[i]\n if(item.errCode == 0) {\n console.log(`第${i}个请求查询到${item.data!.length}条数据`)\n successCount++\n } else {\n console.error(`第${i}个请求查询失败，错误信息：${item.data!.length}`)\n }\n }\n this.multiSendSuccessCount = successCount\n this.notify(`合并查询成功，成功查询的语句条数为：${successCount}`, '提示')\r\n })\r\n .catch((err : any | null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\n console.error(err)\n this.notify(error.errMsg, '错误')\r\n })\r\n }\n }\n }\n\n```\n:::"},"onResponse":{"name":"## onResponse(callback) @onresponse","description":"监听响应事件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any \\| null | 是 | - | - | - | \n\n#### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 响应事件类型 |\n| name | string | 是 | - | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | - | 响应结果、错误内容 |\n","returnValue":"","compatibility":"### onResponse 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-utils.get-current-user-info)\n"},"offResponse":{"name":"## offResponse(callback) @offresponse","description":"移除响应事件监听","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any \\| null | 是 | - | - | - | \n\n#### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 响应事件类型 |\n| name | string | 是 | - | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | - | 响应结果、错误内容 |\n","returnValue":"","compatibility":"### offResponse 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-utils.on-response)\n"},"onRefreshToken":{"name":"## onRefreshToken(callback) @onrefreshtoken","description":"监听token刷新事件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any \\| null | 是 | - | - | - | \n\n#### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 响应事件类型 |\n| name | string | 是 | - | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | - | 响应结果、错误内容 |\n","returnValue":"","compatibility":"### onRefreshToken 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-utils.off-response)\n"},"offRefreshToken":{"name":"## offRefreshToken(callback) @offrefreshtoken","description":"移除token刷新事件监听","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any \\| null | 是 | - | - | - | \n\n#### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 响应事件类型 |\n| name | string | 是 | - | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | - | 响应结果、错误内容 |\n","returnValue":"","compatibility":"### offRefreshToken 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-utils.on-refresh-token)\n"},"getCurrentUserInfo":{"name":"## getCurrentUserInfo() @getcurrentuserinfo","description":"获取token内缓存的用户信息","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **UniCloudUserInfo** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| uid | string \\| null | 否 | - | - | UserInfo = {
/ |\n@| role | Array\\ | 是 | - | - | ing \\| null; / |\n@| permission | Array\\ | 是 | - | - | ay\\; / |\n@| tokenExpired | number | 是 | - | - | ay\\; /** | \n","compatibility":"### getCurrentUserInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-utils.off-refresh-token)\n"}} \ No newline at end of file +{"uniCloud_props":{"name":"# uniCloud","description":"","param":"## 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| config | **UniCloudInitOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| provider | string | 是 | - | - | 服务商，目前支持 aliyun、tencent、alipay |\n@| spaceName | string | 否 | - | - | 服务空间名 |\n@| spaceId | string | 是 | - | - | 服务空间id |\n@| clientSecret | string | 否 | - | - | 阿里云clientSecret |\n@| endpoint | string | 否 | - | - | 阿里云endpoint |\n@| spaceAppId | string | 否 | - | - | 支付宝小程序云spaceAppId |\n@| accessKey | string | 否 | - | - | 支付宝小程序云accessKey |\n@| secretKey | string | 否 | - | - | 支付宝小程序云secretKey |\n| mixinDatacom | any | 是 | - | - | - | \n","returnValue":"","compatibility":"","tutorial":""},"callFunction":{"name":"## callFunction(options) @callfunction","description":"请求云函数","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UniCloudCallFunctionOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| name | string ([string.CloudFunctionString](/uts/data-type.md#ide-string)) | 是 | - | - | 云函数名 |\n@| data | any | 否 | - | - | 云函数参数 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudCallFunctionResult\\](#unicloudcallfunctionresult-values)> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| result | T | 是 | - | - | 云函数返回结果 |\n@| requestId | string | 否 | - | - | 云函数请求id | \n","compatibility":"### callFunction 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-call-function.callFunction)\n"},"unicloud-call-function":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/unicloud-call-function/unicloud-call-function.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud-call-function/unicloud-call-function\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: '请求云函数',\n callFunctionResult: {},\n callFunctionError: {},\n genericDemoShowMessage: '',\n isUniTest: false\n }\n },\n onLoad() {\n },\n onUnload() {\n if (this.isUniTest) {\n uni.hideToast()\n }\n },\n methods: {\n notify(content : string, title : string) {\n if (!this.isUniTest) {\n uni.showModal({\n title,\n content,\n showCancel: false\n })\n } else {\n console.log(title, content)\n }\n },\n async callFunctionWithGeneric() : Promise {\n type EchoCfResult = {\n showMessage: string\n }\n uni.showLoading({\n title: '加载中...'\n })\n await uniCloud.callFunction({\n name: 'echo-cf',\n data: {\n num: 1,\n str: 'ABC'\n }\n }).then(res => {\n const result = res.result\n uni.hideLoading()\n this.genericDemoShowMessage = result.showMessage\n this.notify(result.showMessage, '提示')\n }).catch((err : any | null) => {\n const error = err as UniCloudError\n this.callFunctionError = {\n errCode: error.errCode,\n errMsg: error.errMsg\n }\n uni.hideLoading()\n this.notify(error.errMsg, '错误')\n })\n },\n async callFunction() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n await uniCloud.callFunction({\n name: 'echo-cf',\n data: {\n num: 1,\n str: 'ABC'\n }\n }).then(res => {\n const result = res.result\n this.callFunctionResult = result\n console.log(JSON.stringify(result))\n uni.hideLoading()\n this.notify(result['showMessage'] as string, '提示')\n }).catch((err : any | null) => {\n const error = err as UniCloudError\n this.callFunctionError = {\n errCode: error.errCode,\n errMsg: error.errMsg\n }\n uni.hideLoading()\n this.notify(error.errMsg, '错误')\n })\n }\n }\n }\n\n```\n:::"},"importObject":{"name":"## importObject(objectName, options?) @importobject","description":"引用云对象","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| objectName | string ([string.CloudObjectString](/uts/data-type.md#ide-string)) | 是 | - | - | - |\n| options | **UniCloudImportObjectOptions** | 否 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| customUI | boolean \\| null | 否 | - | - | 是否移除自动展示的ui |\n@| loadingOptions | **UniCloudImportObjectLoadingOptions** \\| null | 否 | - | - | loading界面配置 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| title | string \\| null | 否 | - | - | 加载框标题 |\n@@| mask | boolean \\| null | 否 | - | - | 加载框是否显示mask |\n@| errorOptions | **UniCloudImportObjectErrorOptions** \\| null | 否 | - | - | 错误提示配置 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| type | string \\| null | 否 | - | - | 错误提示类型，可以是modal或者toast |\n@@| retry | boolean \\| null | 否 | - | - | 是否显示重试按钮 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudCloudObjectCaller](#unicloudcloudobjectcaller-values) |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| _obj | [InternalUniCloudCloudObject](#internalunicloudcloudobject-values) | 是 | - | - | - |\n##### InternalUniCloudCloudObject 的方法 @internalunicloudcloudobject-values \n\n##### callMethod(methodName, args) @callmethod\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| methodName | string | 是 | - | - | - |\n| args | Array\\ | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\ |\n \n\n###### callMethod 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### UniCloudCloudObjectCaller 的方法 @unicloudcloudobjectcaller-values \n\n#### _getArgs(args?) @_getargs\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| args | Array\\ | 否 | - | - | - | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Array\\ |\n \n\n##### _getArgs 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n","compatibility":"### importObject 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-import-object.importObject)\n"},"unicloud-import-object":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/unicloud-import-object/unicloud-import-object.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud-import-object/unicloud-import-object\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: '请求云对象',\n todoTitle: '学习编程',\n todoContent: '熟悉uts语法',\n returnTodoTitle: '',\n returnTodoContent: '',\n genericDemoReturnTodoTitle: '',\n genericDemoReturnTodoContent: '',\n failErrCode: '',\n failNumberErrCode: 0,\n successErrCode: -1,\n isUniTest: false\n }\n },\n methods: {\n notify(content : string, title : string) {\n if (!this.isUniTest) {\n uni.showModal({\n title,\n content,\n showCancel: false\n })\n } else {\n console.log(title, content)\n }\n },\n async addTodo() : Promise {\n const todo = uniCloud.importObject('todo', {\n customUI: this.isUniTest\n })\n const title = this.todoTitle\n const content = this.todoContent\n await todo.add(title, content).then((res : UTSJSONObject) => {\n this.returnTodoTitle = res['title'] as string\n this.returnTodoContent = res['content'] as string\n this.notify(res['showMessage'] as string, '提示')\n }).catch((err : any | null) => {\n console.log(err)\n const error = err as UniCloudError\n console.error(error)\n })\n },\n async addTodoWithGeneric() : Promise {\n type AddTodoResult = {\n title: string,\n content: string,\n showMessage: string\n }\n const todo = uniCloud.importObject('todo', {\n customUI: this.isUniTest\n })\n const title = this.todoTitle\n const content = this.todoContent\n await todo.add(title, content).then((res : AddTodoResult) => {\n this.genericDemoReturnTodoTitle = res.title\n this.genericDemoReturnTodoContent = res.content\n this.notify(res.showMessage, '提示')\n }).catch((err : any | null) => {\n console.log(err)\n const error = err as UniCloudError\n console.error(error)\n })\n },\n async randomFail() : Promise {\n const todoObj = uniCloud.importObject('todo', {\n errorOptions: {\n retry: true\n }\n })\n await todoObj.randomFail().then((res : UTSJSONObject) => {\n this.notify(res['showMessage'] as string, '提示')\n }).catch((err : any | null) => {\n const error = err as UniCloudError\n console.error(error)\n })\n },\n async fail() : Promise {\n const todo = uniCloud.importObject('todo', {\n customUI: this.isUniTest\n })\n await todo.fail().then((res : UTSJSONObject) => {\n this.notify('todo.fail应调用失败，此处错误的触发了成功回调', '错误')\n console.log('todo.fail: ', res);\n }).catch((err : any | null) => {\n const error = err as UniCloudError\n this.failErrCode = error.errCode as string\n console.error(error)\n })\n },\n async failWithNumberErrCode() : Promise {\n const todo = uniCloud.importObject('todo', {\n customUI: this.isUniTest\n })\n await todo.failWithNumberErrCode().then((res : UTSJSONObject) => {\n this.notify('todo.fail应调用失败，此处错误的触发了成功回调', '错误')\n console.log('todo.fail: ', res);\n }).catch((err : any | null) => {\n const error = err as UniCloudError\n this.failNumberErrCode = error.errCode as number\n console.error(error)\n })\n },\n async success() : Promise {\n const todo = uniCloud.importObject('todo', {\n customUI: this.isUniTest\n })\n await todo.success().then((res : UTSJSONObject) => {\n this.successErrCode = res['errCode'] as number\n this.notify(res['showMessage'] as string, '提示')\n }).catch((err : any | null) => {\n const error = err as UniCloudError\n console.error(error)\n })\n }\n }\n }\n\n```\n:::"},"uploadFile":{"name":"## uploadFile(options) @uploadfile","description":"上传文件到云存储","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [UniCloudUploadFileOptions](#uniclouduploadfileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | string | 是 | - | - | 文件路径 |\n@| cloudPath | string | 是 | - | - | 云端路径 |\n@| cloudPathAsRealPath | boolean | 否 | - | - | 是否以云端路径是否为真实路径保存上传的文件 | \n\n#### UniCloudUploadFileOptions 的方法 @uniclouduploadfileoptions-values \n\n#### onUploadProgress(options) @onuploadprogress\n上传进度回调\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UniCloudUploadProgress** | 是 | - | - | 上传进度回调参数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| loaded | number | 是 | - | - | 已上传大小 |\n@| total | number | 是 | - | - | 总大小 | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n##### onUploadProgress 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudUploadFileResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | string | 是 | - | - | 文件路径 |\n@| fileID | string | 是 | - | - | 文件id | \n","compatibility":"### uploadFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-file-api.upload-file)\n"},"getTempFileURL":{"name":"## getTempFileURL(options) @gettempfileurl","description":"获取文件临时URL","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UniCloudGetTempFileURLOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fileList | Array\\ | 是 | - | - | 文件列表 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudGetTempFileURLResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fileList | Array\\<**UniCloudGetTempFileURLResultItem**\\> | 是 | - | - | 文件列表 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| fileID | string | 是 | - | - | 文件id |\n@@| tempFileURL | string | 是 | - | - | 文件临时url | \n","compatibility":"### getTempFileURL 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-file-api.choose-and-upload-file)\n"},"chooseAndUploadFile":{"name":"## chooseAndUploadFile(options) @chooseanduploadfile","description":"选择并上传文件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [UniCloudChooseAndUploadFileOptions](#unicloudchooseanduploadfileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| sourceType | Array\\ \\| null | 否 | - | - | |\n@| count | number \\| null | 否 | - | - | |\n@| sizeType | Array\\ \\| null | 否 | - | - | |\n@| extension | Array\\ \\| null | 否 | - | - | |\n@| compressed | boolean \\| null | 否 | - | - | |\n@| maxDuration | number \\| null | 否 | - | - | |\n@| camera | string \\| null | 否 | - | - | |\n@| crop | ChooseImageCropOptions \\| null | 否 | - | - | |\n@| type | string | 是 | - | - | - | \n\n#### UniCloudChooseAndUploadFileOptions 的方法 @unicloudchooseanduploadfileoptions-values \n\n#### onChooseFile(arg) @onchoosefile\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | **UniCloudChooseFileResult** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| tempFiles | Array\\<**UniCloudChooseFileItem**\\> | 是 | - | - | - |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| name | string | 是 | - | - | - |\n@@| path | string | 是 | - | - | - |\n@@| cloudPath | string | 是 | - | - | - |\n@@| cloudPathAsRealPath | boolean \\| null | 否 | - | - | |\n@@| url | string \\| null | 否 | - | - | |\n@@| errMsg | string \\| null | 否 | - | - | |\n@| tempFilePaths | Array\\ | 是 | - | - | - | \n\n##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| void \\| null | 否 |\n \n\n##### onChooseFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### onUploadProgress(arg) @onuploadprogress\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | **UniCloudChooseAndUploadFileProgressEvent** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| index | number | 是 | - | - | - |\n@| loaded | number | 是 | - | - | - |\n@| total | number | 是 | - | - | - |\n@| tempFilePath | string | 是 | - | - | - |\n@| tempFile | **UniCloudChooseFileItem** | 是 | - | - | - |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| name | string | 是 | - | - | - |\n@@| path | string | 是 | - | - | - |\n@@| cloudPath | string | 是 | - | - | - |\n@@| cloudPathAsRealPath | boolean \\| null | 否 | - | - | |\n@@| url | string \\| null | 否 | - | - | |\n@@| errMsg | string \\| null | 否 | - | - | | \n\n##### 返回值 \n\n| 类型 | 必备 |\n| :- | :- |\n| void \\| null | 否 |\n \n\n##### onUploadProgress 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudChooseAndUploadFileResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| tempFiles | Array\\<**UniCloudChooseFileItem**\\> | 是 | - | - | - |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| name | string | 是 | - | - | - |\n@@| path | string | 是 | - | - | - |\n@@| cloudPath | string | 是 | - | - | - |\n@@| cloudPathAsRealPath | boolean \\| null | 否 | - | - | |\n@@| url | string \\| null | 否 | - | - | |\n@@| errMsg | string \\| null | 否 | - | - | |\n@| tempFilePaths | Array\\ | 是 | - | - | - | \n","compatibility":"### chooseAndUploadFile 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-file-api.getTempFileURL)\n"},"unicloud-file-api":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/unicloud-file-api/unicloud-file-api.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud-file-api/unicloud-file-api\n>Template\n```vue\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: '云存储'\n }\n },\n onLoad() {\n },\n onUnload() {\n },\n methods: {\n uploadFile: function () {\n uni.chooseImage({\n count: 1,\n success(res) : void {\n uni.showLoading({\n title: '上传中...'\n })\n const tempFilePath = res.tempFilePaths[0]\n uniCloud.uploadFile({\n filePath: tempFilePath,\n cloudPath: 'test.jpg'\n })\n .then(function (res) {\n uni.hideLoading()\n console.log(res)\n uni.showModal({\n content: '上传成功',\n showCancel: false\n });\n })\n .catch(function (err : any | null) {\n uni.hideLoading()\n const error = err as UniCloudError\n uni.showModal({\n content: '上传失败，' + error.errMsg,\n showCancel: false\n });\n })\n // .finally((_: number) : void => {\n // uni.hideLoading()\n // })\n },\n fail(err) : void {\n console.error('chooseImage fail: ', err)\n }\n })\n }\n }\n }\n\n```\n:::"},"databaseForJQL":{"name":"## databaseForJQL() @databaseforjql","description":"获取数据库操作实例","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [Database](#database-values) |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| command | any | 是 | - | - | - |\n@| Geo | any | 是 | - | - | - |\n#### Database 的方法 @database-values \n\n#### collection(args?) @collection\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| args | Array\\ | 否 | - | - | - | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [Collection](#collection-values) |\n\n##### Collection 的方法 @collection-values \n\n##### where(condition) @where\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| condition | any | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n\n##### UniCloudDBFilter 的方法 @uniclouddbfilter-values \n\n##### get(arg?) @get\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | any \\| null | 否 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBGetResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| data | Array\\ | 是 | - | - | etResult = {
/** |\n@| count | number \\| null | 否 | - | - | JSONObject>;
/** |\n@| requestId | string | 否 | - | - | ber \\| null;
/ | \n\n###### get 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### count() @count\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBCountResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| total | number | 是 | - | - | ntResult = {
/** |\n@| requestId | string | 否 | - | - | al: number;
/ | \n\n###### count 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### update(data) @update\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | any | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBUpdateResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| updated | number | 是 | - | - | teResult = {
/** |\n@| requestId | string | 否 | - | - | ted: number;
/ | \n\n###### update 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### remove() @remove\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBRemoveResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| deleted | number | 是 | - | - | veResult = {
/** |\n@| requestId | string | 否 | - | - | ted: number;
/ | \n\n###### remove 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### getTemp() @gettemp\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n###### getTemp 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### where(condition) @where\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| condition | any | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### where 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### doc(docId) @doc\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| docId | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### doc 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### field(filed) @field\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filed | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n\n##### UniCloudDBQuery 的方法 @uniclouddbquery-values \n\n##### get(arg?) @get\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | any \\| null | 否 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudDBGetResult](#uniclouddbgetresult-values)> |\n \n\n###### get 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### count() @count\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudDBCountResult](#uniclouddbcountresult-values)> |\n \n\n###### count 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### getTemp() @gettemp\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n###### getTemp 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### field(filed) @field\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filed | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### field 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### skip(num) @skip\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### skip 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### limit(num) @limit\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### limit 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### orderBy(order) @orderby\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| order | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### orderBy 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### groupBy(field) @groupby\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### groupBy 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### groupField(field) @groupfield\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### groupField 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### distinct(field) @distinct\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### distinct 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### geoNear(options) @geonear\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | any | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### geoNear 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n\n###### field 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### skip(num) @skip\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### skip 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### limit(num) @limit\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### limit 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### orderBy(order) @orderby\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| order | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### orderBy 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### groupBy(field) @groupby\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### groupBy 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### groupField(field) @groupfield\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### groupField 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### distinct(field) @distinct\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### distinct 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### geoNear(options) @geonear\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | any | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### geoNear 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n\n###### where 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### doc(docId) @doc\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| docId | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### doc 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### aggregate() @aggregate\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### aggregate 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### foreignKey(foreignKey) @foreignkey\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| foreignKey | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### foreignKey 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### add(data) @add\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | any | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBAddResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| id | string | 是 | - | - | ddResult = {
/** |\n@| requestId | string | 否 | - | - | string;
/ | \n\n###### add 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### get(arg?) @get\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | any \\| null | 否 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudDBGetResult](#uniclouddbgetresult-values)> |\n \n\n###### get 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### count() @count\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudDBCountResult](#uniclouddbcountresult-values)> |\n \n\n###### count 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### getTemp() @gettemp\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n###### getTemp 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### field(filed) @field\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filed | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### field 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### skip(num) @skip\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### skip 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### limit(num) @limit\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### limit 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n##### orderBy(order) @orderby\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| order | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### orderBy 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n \n\n##### collection 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| - | - | - |\n\n\n#### multiSend(args?) @multisend\n合并查询请求\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| args | Array\\ | 否 | - | - | - | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBMultiSendResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| dataList | Array\\<**UniCloudDBMultiSendResultItem**\\> | 是 | - | - | SendResult = { |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| errCode | any | 是 | - | - | ResultItem = {
/**
错误码，可 |\n@@| errMsg | string | 是 | - | - | errCode : any |\n@@| data | Array\\ | 否 | - | - | Msg : stri |\n@| requestId | string | 否 | - | - | ndResultItem[\\] | \n\n##### multiSend 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 4.16 | 4.11 | 4.0 |\n\n \n","compatibility":"### databaseForJQL 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.91，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-database.databaseForJQL)\n"},"unicloud-database":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha/pages/API/unicloud-database/unicloud-database.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud-database/unicloud-database\n>Template\n```vue\n\n\n\n\n\n\n```\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: 'ClientDB',\n addId: '',\n batchAddIds: [] as Array,\n batchAddinserted: 0,\n updateUpdated: 0,\n getData: [] as Array,\n getWithCommandData: [] as Array,\n removeDeleted: 0,\n lookupData: [] as Array,\n multiSendSuccessCount: 0,\n isUniTest: false\n }\n },\n computed: {\n dataTag() : string {\n return this.isUniTest ? 'default-tag' + Date.now() : 'default-tag'\n }\n },\n methods: {\n notify(content : string, title : string) {\n if (!this.isUniTest) {\n uni.showModal({\n title,\n content,\n showCancel: false\n })\n } else {\n console.log(title, content)\n }\n },\n async dbAdd() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .add({\n num: 1,\n tag: this.dataTag,\n date: new Date()\n })\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.addId = res.id\n this.notify(`新增成功，id: ${res.id}`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbBatchAdd() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .add([{\n num: 2,\n tag: this.dataTag,\n }, {\n num: 3,\n tag: this.dataTag,\n }])\n .then((res) => {\n uni.hideLoading()\n console.log(res)\n console.log('JSON.stringify(res.inserted)', JSON.stringify(res.inserted))\n this.batchAddIds = res.ids\n this.batchAddinserted = res.inserted\n this.notify(`新增成功条数${res.inserted}, id列表: ${res.ids.join(',')}`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbGet() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .where(\n `tag == \"${this.dataTag}\"`\n )\n .field('num, tag')\n .orderBy('num desc')\n .skip(1)\n .limit(2)\n .get()\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.getData = res.data\n this.notify(`获取成功，取到了${res.data.length}条数据`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbGetWithCommand() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .where({\n num: db.command.gt(1),\n tag: this.dataTag\n })\n .field('num, tag')\n .orderBy('num desc')\n .skip(1)\n .limit(2)\n .get()\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.getWithCommandData = res.data\n this.notify(`获取成功，取到了${res.data.length}条数据`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbUpdate() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .where(\n `tag == \"${this.dataTag}\"`\n )\n .update({\n num: 4\n })\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.updateUpdated = res.updated\n this.notify(`更新成功，更新了${res.updated}条数据`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbRemove() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .where(\n `tag == \"${this.dataTag}\"`\n )\n .remove()\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.removeDeleted = res.deleted\n this.notify(`删除成功，删掉了${res.deleted}条数据`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbLookupInit() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('local')\n .where(`tag == \"${this.dataTag}\"`)\n .remove()\n .then(() : Promise => {\n return db.collection('foreign')\n .where(`tag == \"${this.dataTag}\"`)\n .remove()\n })\n .then(() : Promise => {\n return db.collection('local')\n .add([{\n id: \"local_1\",\n name: \"local_1_name\",\n tag: this.dataTag,\n foreign_id: \"foreign_1\"\n }, {\n id: \"local_2\",\n name: \"local_2_name\",\n tag: this.dataTag,\n foreign_id: \"foreign_2\"\n }])\n })\n .then(() : Promise => {\n return db.collection('foreign')\n .add([{\n id: \"foreign_1\",\n name: \"foreign_1_name\",\n tag: this.dataTag\n }, {\n id: \"foreign_2\",\n name: \"foreign_2_name\",\n tag: this.dataTag\n }])\n })\n .then((_) : void => {\n uni.hideLoading()\n this.notify('数据初始化成功', '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n console.error(err)\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbLookup() : Promise {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n const local = db.collection('local')\n .where(`tag == \"${this.dataTag}\"`)\n .getTemp()\n const foreign = db.collection('foreign')\n .where(`tag == \"${this.dataTag}\"`)\n .getTemp()\n await db.collection(local, foreign)\n .get()\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.lookupData = res.data\n this.notify(`联表查询成功，取到了${res.data.length}条数据`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbMultiSend() : Promise {\n const db = uniCloud.databaseForJQL()\n const temp1 = db.collection('type')\n .where(\n 'tag == \"default-tag\"'\n ).getTemp()\n const temp2 = db.collection('type')\n .where(\n 'tag == \"default-tag\"'\n ).getTemp()\n await db.multiSend(temp1, temp2)\n .then(res => {\n uni.hideLoading()\n let successCount = 0\n for (let i = 0; i < res.dataList.length; i++) {\n const item = res.dataList[i]\n if(item.errCode == 0) {\n console.log(`第${i}个请求查询到${item.data!.length}条数据`)\n successCount++\n } else {\n console.error(`第${i}个请求查询失败，错误信息：${item.data!.length}`)\n }\n }\n this.multiSendSuccessCount = successCount\n this.notify(`合并查询成功，成功查询的语句条数为：${successCount}`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n console.error(err)\n this.notify(error.errMsg, '错误')\n })\n }\n }\n }\n\n```\n:::"},"onResponse":{"name":"## onResponse(callback) @onresponse","description":"监听响应事件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any \\| null | 是 | - | - | - | \n\n#### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 响应事件类型 |\n| name | string | 是 | - | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | - | 响应结果、错误内容 |\n","returnValue":"","compatibility":"### onResponse 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-utils.get-current-user-info)\n"},"offResponse":{"name":"## offResponse(callback) @offresponse","description":"移除响应事件监听","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any \\| null | 是 | - | - | - | \n\n#### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 响应事件类型 |\n| name | string | 是 | - | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | - | 响应结果、错误内容 |\n","returnValue":"","compatibility":"### offResponse 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-utils.on-response)\n"},"onRefreshToken":{"name":"## onRefreshToken(callback) @onrefreshtoken","description":"监听token刷新事件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any \\| null | 是 | - | - | - | \n\n#### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 响应事件类型 |\n| name | string | 是 | - | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | - | 响应结果、错误内容 |\n","returnValue":"","compatibility":"### onRefreshToken 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-utils.off-response)\n"},"offRefreshToken":{"name":"## offRefreshToken(callback) @offrefreshtoken","description":"移除token刷新事件监听","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any \\| null | 是 | - | - | - | \n\n#### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 响应事件类型 |\n| name | string | 是 | - | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | - | 响应结果、错误内容 |\n","returnValue":"","compatibility":"### offRefreshToken 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-utils.on-refresh-token)\n"},"getCurrentUserInfo":{"name":"## getCurrentUserInfo() @getcurrentuserinfo","description":"获取token内缓存的用户信息","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **UniCloudUserInfo** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| uid | string \\| null | 否 | - | - | UserInfo = {
/ |\n@| role | Array\\ | 是 | - | - | ing \\| null;
/ |\n@| permission | Array\\ | 是 | - | - | ay\\;
/ |\n@| tokenExpired | number | 是 | - | - | ay\\;
/** | \n","compatibility":"### getCurrentUserInfo 兼容性 \n| Android | iOS | web |\n| :- | :- | :- |\n| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 | 4.0 |\n","tutorial":"\n### 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.unicloud-utils.off-refresh-token)\n"}} \ No newline at end of file diff --git a/docs/.vuepress/utils/vueJson.json b/docs/.vuepress/utils/vueJson.json index 32351820c98a76ac2ae7b35e8cfef99f96917a11..56cce532488acaff1699f2a4b35e40e3a694f826 100644 --- a/docs/.vuepress/utils/vueJson.json +++ b/docs/.vuepress/utils/vueJson.json @@ -1 +1 @@ -{"template":{"name":"#### template","description":"","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| lang | string | - | | |\n@| 值名称 | 兼容性 | 描述 |\n@| :- | :-: | :- |\n@| html | - | html |\n@| pug | - | 仅 Web 端支持 |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","children":"","reference":""},"slot":{"name":"#### slot","description":"> 组件类型：string \n\n \\ 元素作为组件模板之中的内容分发插槽。\\ 元素自身将被替换。","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| name | string | - | - | 用于命名插槽。 |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","children":"","reference":"\n##### 参见\n- [Reference](https://v3.cn.vuejs.org/api/built-in-components.html#slot)\n"},"script":{"name":"#### script","description":"","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| setup | Any | - | | - |\n| lang | Any | - | | |\n@| 值名称 | 兼容性 | 描述 |\n@| :- | :-: | :- |\n@| uts | | uts |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","children":"","reference":""},"style":{"name":"#### style","description":"","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| lang | string | - | | |\n@| 值名称 | 兼容性 | 描述 |\n@| :- | :-: | :- |\n@| scss | - | - |\n@| less | - | - |\n@| stylus | - | - |\n| scoped | Any | - | | - |\n| module | Any | - | | - |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","children":"","reference":""},"keep-alive":{"name":"#### keep-alive","description":"> 组件类型：string \n\n \\ 包裹动态组件时，会缓存不活动的组件实例，而不是销毁它们。和 \\ 相似，\\ 是一个抽象组件：它自身不会渲染一个 DOM 元素，也不会出现在父组件链中。","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| include | string | - | - | 字符串或正则表达式。只有名称匹配的组件会被缓存。 |\n| exclude | string | - | - | 字符串或正则表达式。任何名称匹配的组件都不会被缓存。 |\n| max | string | - | - | 最多可以缓存多少组件实例。 |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| 4.0 | 4.11 | 4.0 |\n","children":"","reference":"\n##### 参见\n- [Reference](https://v3.cn.vuejs.org/api/built-in-components.html#keep-alive)\n"},"component":{"name":"#### component","description":"> 组件类型：string \n\n 渲染一个“元组件”为动态组件。依 is 的值，来决定哪个组件被渲染。","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| is | Any | - | - | - |\n| inline-template | Any | - | - | - |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.99 | 4.11 | 4.0 |\n","children":"","reference":"\n##### 参见\n- [Reference](https://v3.cn.vuejs.org/api/built-in-components.html#component)\n"},"transition":{"name":"#### transition","description":"> 组件类型：string \n\n \\ 元素作为单个元素/组件的过渡效果。\\ 只会把过渡效果应用到其包裹的内容上，而不会额外渲染 DOM 元素，也不会出现在检测过的组件层级中。","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| name | string | - | - | 用于自动生成 CSS 过渡类名。例如：name: 'fade' 将自动拓展为.fade-enter，.fade-enter-active等。默认类名为 \"v\" |\n| appear | string(true \\| false) | - | - | 是否在初始渲染时使用过渡。默认为 false。 |\n| css | string(true \\| false) | - | - | 是否使用 CSS 过渡类。默认为 true。如果设置为 false，将只通过组件事件触发注册的 JavaScript 钩子。 |\n| type | string | - | - | 指定过渡事件类型，侦听过渡何时结束。有效值为 \"transition\" 和 \"animation\"。默认 Vue.js 将自动检测出持续时间长的为过渡事件类型。 |\n@| 值名称 | 兼容性 | 描述 |\n@| :- | :-: | :- |\n@| transition | - | - |\n@| animation | - | - |\n| mode | string | - | - | 控制离开/进入的过渡时间序列。有效的模式有 \"out-in\" 和 \"in-out\"；默认同时生效。 |\n@| 值名称 | 兼容性 | 描述 |\n@| :- | :-: | :- |\n@| out-in | - | - |\n@| in-out | - | - |\n| duration | string | - | - | 指定过渡的持续时间。默认情况下，Vue 会等待过渡所在根元素的第一个 transitionend 或 animationend 事件。 |\n| enter-class | Any | - | - | - |\n| leave-class | Any | - | - | - |\n| appear-class | Any | - | - | - |\n| enter-to-class | Any | - | - | - |\n| leave-to-class | Any | - | - | - |\n| appear-to-class | Any | - | - | - |\n| enter-active-class | Any | - | - | - |\n| leave-active-class | Any | - | - | - |\n| appear-active-class | Any | - | - | - |\n| @before-enter | Any | - | - | - |\n| @before-leave | Any | - | - | - |\n| @before-appear | Any | - | - | - |\n| @enter | Any | - | - | - |\n| @leave | Any | - | - | - |\n| @appear | Any | - | - | - |\n| @after-enter | Any | - | - | - |\n| @after-leave | Any | - | - | - |\n| @after-appear | Any | - | - | - |\n| @enter-cancelled | Any | - | - | - |\n| @leave-cancelled | string | - | - | v-show only |\n| @appear-cancelled | Any | - | - | - |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |\n","children":"","reference":"\n##### 参见\n- [Reference](https://v3.cn.vuejs.org/api/built-in-components.html#transition)\n"},"transition-group":{"name":"#### transition-group","description":"> 组件类型：string \n\n \\ 元素作为多个元素/组件的过渡效果。\\ 渲染一个真实的 DOM 元素。默认渲染 \\，可以通过 tag 属性配置哪个元素应该被渲染。","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| tag | string | - | - | 默认为 span。 |\n| move-class | string | - | - | 覆盖移动过渡期间应用的 CSS 类。 |\n| name | string | - | - | 用于自动生成 CSS 过渡类名。例如：name: 'fade' 将自动拓展为.fade-enter，.fade-enter-active等。默认类名为 \"v\" |\n| appear | string(true \\| false) | - | - | 是否在初始渲染时使用过渡。默认为 false。 |\n| css | string(true \\| false) | - | - | 是否使用 CSS 过渡类。默认为 true。如果设置为 false，将只通过组件事件触发注册的 JavaScript 钩子。 |\n| type | string | - | - | 指定过渡事件类型，侦听过渡何时结束。有效值为 \"transition\" 和 \"animation\"。默认 Vue.js 将自动检测出持续时间长的为过渡事件类型。 |\n@| 值名称 | 兼容性 | 描述 |\n@| :- | :-: | :- |\n@| transition | - | - |\n@| animation | - | - |\n| mode | Any | - | - | - |\n| duration | string | - | - | 指定过渡的持续时间。默认情况下，Vue 会等待过渡所在根元素的第一个 transitionend 或 animationend 事件。 |\n| enter-class | Any | - | - | - |\n| leave-class | Any | - | - | - |\n| appear-class | Any | - | - | - |\n| enter-to-class | Any | - | - | - |\n| leave-to-class | Any | - | - | - |\n| appear-to-class | Any | - | - | - |\n| enter-active-class | Any | - | - | - |\n| leave-active-class | Any | - | - | - |\n| appear-active-class | Any | - | - | - |\n| @before-enter | Any | - | - | - |\n| @before-leave | Any | - | - | - |\n| @before-appear | Any | - | - | - |\n| @enter | Any | - | - | - |\n| @leave | Any | - | - | - |\n| @appear | Any | - | - | - |\n| @after-enter | Any | - | - | - |\n| @after-leave | Any | - | - | - |\n| @after-appear | Any | - | - | - |\n| @enter-cancelled | Any | - | - | - |\n| @leave-cancelled | string | - | - | v-show only |\n| @appear-cancelled | Any | - | - | - |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |\n","children":"","reference":"\n##### 参见\n- [Reference](https://v3.cn.vuejs.org/api/built-in-components.html#transition-group)\n"},"teleport":{"name":"#### teleport","description":"> 组件类型：string \n\n Teleport 提供了一种干净的方法，允许我们控制在 DOM 中哪个父节点下呈现 HTML，而不必求助于全局状态或将其拆分为两个组件。","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| to | string | - | - | 必须是有效的查询选择器或 HTMLElement (如果在浏览器环境中使用)。指定将在其中移动 \\ 内容的目标元素 |\n| disabled | boolean | - | - | 此可选属性可用于禁用 \\ 的功能，这意味着其插槽内容将不会移动到任何位置，而是在您在周围父组件中指定了 \\ 的位置渲染。 |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| 4.0 | 4.11 | 4.0 |\n","children":"","reference":"\n##### 参见\n- [Reference](https://v3.vuejs.org/api/built-in-components.html#teleport)\n"},"application":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| createApp() | √ | 4.11 | 4.0 |\n| createSSRApp() | √ | 4.11 | 4.0 |\n| app.mount() | √ | 4.11 | 4.0 |\n| app.unmount() | √ | 4.11 | 4.0 |\n| app.component() | √ | 4.11 | 4.0 |\n| app.directive() | - | - | - |\n| app.use() | 3.99 | 4.11 | 4.0 |\n| app.mixin() | 3.99 | 4.11 | 4.0 |\n| app.provide() | 3.99 | 4.11 | 4.0 |\n| app.runWithContext() | - | - | - |\n| app.version | √ | 4.11 | 4.0 |\n| app.config | - | - | - |\n| app.config.errorHandler | x | 4.11 | 4.0 |\n| app.config.warnHandler | - | - | - |\n| app.config.performance | - | - | - |\n| app.config.compilerOptions | - | - | - |\n| app.config.globalProperties | 3.99 | 4.11 | 4.0 |\n| app.config.optionMergeStrategies | - | - | - |","example":""},"general":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| version | √ | 4.11 | 4.0 |\n| nextTick() | √ | 4.11 | 4.0 |\n| defineComponent() | x | x | 4.0 |\n| defineAsyncComponent() | - | - | - |\n| defineCustomElement() | - | - | - |","example":""},"reactivity_core":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| ref() | √ | 4.11 | 4.0 |\n| computed() | - | - | - |\n| reactive() | √ | 4.11 | 4.0 |\n| readonly() | 4.0 | 4.11 | 4.0 |\n| watchEffect() | 4.0 | 4.11 | 4.0 |\n| watchPostEffect() | 4.0 | 4.11 | 4.0 |\n| watchSyncEffect() | 4.0 | 4.11 | 4.0 |\n| watch() | 4.0 | 4.11 | 4.0 |","example":""},"reactivity_utilities":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| isRef() | 4.0 | 4.11 | 4.0 |\n| unref() | 4.0 | 4.11 | 4.0 |\n| toRef() | 4.0 | 4.11 | 4.11 |\n| toValue() | 4.0 | 4.11 | 4.11 |\n| toRefs() | 4.0 | 4.11 | 4.11 |\n| isProxy() | 4.0 | 4.11 | 4.0 |\n| isReactive() | 4.0 | 4.11 | 4.0 |\n| isReadonly() | 4.0 | 4.11 | 4.0 |","example":""},"reactivity_advanced":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| shallowRef() | 4.0 | 4.11 | 4.0 |\n| triggerRef() | 4.0 | 4.11 | x |\n| customRef() | 4.0 | 4.11 | 4.0 |\n| shallowReactive() | 4.0 | 4.11 | 4.0 |\n| shallowReadonly() | 4.0 | 4.11 | 4.0 |\n| toRaw() | 4.0 | 4.11 | 4.0 |\n| markRaw() | - | - | - |\n| effectScope() | 4.0 | 4.11 | 4.0 |\n| getCurrentScope() | 4.0 | 4.11 | 4.0 |\n| onScopeDispose() | 4.0 | 4.11 | 4.0 |","example":""},"composition_lifecycle":{"compatibility":"| | Android | iOS | web | 描述 |\n| :- | :- | :- | :- | :- |\n| onMounted() | 4.0 | 4.11 | 4.0 | el 被新创建的 vm.$el 替换，并挂载到实例上去之后调用该钩子。
如果 root 实例挂载了一个文档内元素，当 onMounted 被调用时 vm.$el 也在文档内。 |\n| onUpdated() | 4.0 | 4.11 | 4.0 | 由于数据更改导致的虚拟 DOM 重新渲染和打补丁，在这之后会调用该钩子。 |\n| onUnmounted() | 4.0 | 4.11 | 4.0 | 卸载组件实例后调用。
调用此钩子时，组件实例的所有指令都被解除绑定，所有事件侦听器都被移除，所有子组件实例被卸载。 |\n| onBeforeMount() | 4.0 | 4.11 | 4.0 | 在挂载开始之前被调用：相关的 render 函数首次被调用。 |\n| onBeforeUpdate() | 4.0 | 4.11 | 4.0 | 数据更新时调用，发生在虚拟 DOM 打补丁之前。
这里适合在更新之前访问现有的 DOM，比如手动移除已添加的事件监听器。 |\n| onBeforeUnmount() | 4.0 | 4.11 | 4.0 | 在卸载组件实例之前调用。在这个阶段，实例仍然是完全正常的。 |\n| onErrorCaptured() | - | - | - | - |\n| onRenderTracked() | - | - | - | - |\n| onRenderTriggered() | - | - | - | - |\n| onActivated() | x | x | 4.0 | keep-alive 组件激活时调用。 |\n| onDeactivated() | x | x | 4.0 | keep-alive 组件停用时调用。 |\n| onServerPrefetch() | - | - | - | - |","example":""},"composition_injection":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| provide() | 4.0 | 4.11 | 4.0 |\n| inject() | - | - | - |\n| hasInjectionContext() | 4.0 | 4.11 | 4.11 |","example":""},"options_state":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| data | 3.9 | 4.11 | 4.0 |\n| props | 3.9 | 4.11 | 4.0 |\n| computed | 3.9 | 4.11 | 4.0 |\n| methods | 3.9 | 4.11 | 4.0 |\n| watch | 3.9 | 4.11 | 4.0 |\n| emits | 3.9 | 4.11 | 4.0 |\n| expose | x | x | 4.0 |","example":""},"options_rendering":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| template | - | - | - |\n| render | 3.9 | 4.11 | 4.0 |\n| compilerOptions | - | - | - |\n| slots | 3.9 | 4.11 | 4.0 |","example":""},"options_lifecycle":{"compatibility":"| | Android | iOS | web | 描述 |\n| :- | :- | :- | :- | :- |\n| beforeCreate | 3.9 | 4.11 | 4.0 | 在实例初始化之后，数据观测 (data observer) 和 event/watcher 事件配置之前被调用。 |\n| created | 3.9 | 4.11 | 4.0 | 在实例创建完成后被立即调用。
在这一步，实例已完成以下的配置：数据观测 (data observer)，属性和方法的运算，watch/event 事件回调。
然而，挂载阶段还没开始，$el 属性目前不可见。 |\n| beforeMount | 3.9 | 4.11 | 4.0 | 在挂载开始之前被调用：相关的 render 函数首次被调用。 |\n| mounted | 3.9 | 4.11 | 4.0 | el 被新创建的 vm.$el 替换，并挂载到实例上去之后调用该钩子。
如果 root 实例挂载了一个文档内元素，当 mounted 被调用时 vm.$el 也在文档内。 |\n| beforeUpdate | 3.9 | 4.11 | 4.0 | 数据更新时调用，发生在虚拟 DOM 打补丁之前。
这里适合在更新之前访问现有的 DOM，比如手动移除已添加的事件监听器。 |\n| updated | 3.9 | 4.11 | 4.0 | 由于数据更改导致的虚拟 DOM 重新渲染和打补丁，在这之后会调用该钩子。 |\n| beforeUnmount | 3.9 | 4.11 | 4.0 | 在一个组件实例被卸载之前调用。 |\n| unmounted | 3.9 | 4.11 | 4.0 | 在一个组件实例被卸载之后调用。 |\n| errorCaptured | x | x | 4.0 | \\2.5.0+ 新增\\
当捕获一个来自子孙组件的错误时被调用。
此钩子会收到三个参数：错误对象、发生错误的组件实例以及一个包含错误来源信息的字符串。
此钩子可以返回 false 以阻止该错误继续向上传播。 |\n| renderTracked | x | x | 4.0 | - |\n| renderTriggered | x | x | 4.0 | - |\n| activated | 4.0 | 4.11 | 4.0 | keep-alive 组件激活时调用。 |\n| deactivated | 4.0 | 4.11 | 4.0 | keep-alive 组件停用时调用。 |\n| serverPrefetch | - | - | - | - |","example":""},"options_composition":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| provide | 3.99 | 4.11 | 4.0 |\n| inject | 3.99 | 4.11 | 4.0 |\n| mixins | 3.99 | 4.11 | 4.0 |\n| extends | - | - | - |","example":""},"options_misc":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| name | 3.9 | 4.11 | 4.0 |\n| inheritAttrs | 3.9 | 4.11 | 4.0 |\n| components | 3.9 | 4.11 | 4.0 |\n| directives | - | - | - |","example":""},"component_instance":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| $data | √ | 4.11 | 4.0 |\n| $props | √ | 4.11 | 4.0 |\n| $el | √ | 4.11 | 4.0 |\n| $options | √ | 4.11 | 4.0 |\n| $parent | √ | 4.11 | 4.0 |\n| $root | √ | 4.11 | 4.0 |\n| $slots | √ | 4.11 | 4.0 |\n| $refs | √ | 4.11 | 4.0 |\n| $attrs | √ | 4.11 | 4.0 |\n| $watch() | √ | 4.11 | 4.0 |\n| $emit | √ | 4.11 | 4.0 |\n| $forceUpdate | √ | 4.11 | 4.0 |\n| $nextTick | √ | 4.11 | 4.0 |\n| $callMethod | √ | 4.11 | 4.0 |","example":""},"directives":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| v-text | x | x | 4.0 |\n| v-html | 3.99 | x | 4.0 |\n| v-show | 3.9 | 4.11 | 4.0 |\n| v-if | 3.9 | 4.11 | 4.0 |\n| v-else | 3.9 | 4.11 | 4.0 |\n| v-else-if | 3.9 | 4.11 | 4.0 |\n| v-for | 3.9 | 4.11 | 4.0 |\n| v-on | 3.9 | 4.11 | 4.0 |\n| v-bind | 3.9 | 4.11 | 4.0 |\n| v-model | 3.9 | 4.11 | 4.0 |\n| v-slot | 3.9 | 4.11 | 4.0 |\n| v-pre | 3.99 | 4.11 | 4.0 |\n| v-once | 3.99 | 4.11 | x |\n| v-memo | 3.99 | 4.11 | x |\n| v-cloak | x | x | 4.0 |","example":""},"special_attributes":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| key | 3.9 | 4.11 | 4.0 |\n| ref | 3.9 | 4.11 | 4.0 |\n| is | 3.99 | 4.11 | 4.0 |","example":""},"render_function":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| h() | 3.99 | 4.11 | 4.0 |\n| mergeProps() | 4.0 | 4.11 | 4.0 |\n| cloneVNode() | 4.0 | x | 4.0 |\n| isVNode() | √ | 4.11 | 4.0 |\n| resolveComponent() | √ | 4.11 | 4.0 |\n| resolveDirective() | - | - | - |\n| withDirectives() | x | 4.11 | 4.0 |\n| withModifiers() | √ | 4.11 | 4.0 |","example":""},"single_file_component_script":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| defineProps() | 4.0 | 4.11 | 4.0 |\n| defineEmits() | 4.0 | 4.11 | 4.0 |\n| defineModel() | 4.0 | 4.11 | 4.11 |\n| defineExpose() | 4.0 | 4.11 | 4.0 |\n| defineOptions() | 4.0 | 4.11 | 4.11 |\n| defineSlots() | 4.0 | 4.11 | 4.0 |\n| useSlots() | 4.0 | 4.11 | 4.0 |\n| useAttrs() | 4.0 | 4.11 | 4.0 |","example":""},"eventModifiers":{"stop":{"name":"### stop\n","description":"单击事件将停止传递","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |"},"prevent":{"name":"### prevent\n","description":"提交事件将不再重新加载页面","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"capture":{"name":"### capture\n","description":"添加事件监听器时，使用 `capture` 捕获模式（例如：指向内部元素的事件，在被内部元素处理前，先被外部处理）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"self":{"name":"### self\n","description":"仅当 event.target 是元素本身时才会触发事件处理器（仅当 event.target 是元素本身时才会触发事件处理器）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"once":{"name":"### once\n","description":"点击事件最多被触发一次","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |"},"passive":{"name":"### passive\n","description":"滚动事件的默认行为 (scrolling) 将立即发生而非等待 `onScroll` 完成（滚动事件的默认行为 (scrolling) 将立即发生而非等待 `onScroll` 完成）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"}},"keyModifiers":{"enter":{"name":"### enter\n","description":"仅在 `key` 为 `Enter` 时调用事件处理器（keycode 为 13）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"tab":{"name":"### tab\n","description":"仅在 `key` 为 `Tab` 时调用事件处理器（keycode 为 9）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"delete":{"name":"### delete\n","description":"仅在 `key` 为 `Delete` 或 `Backspace` 时调用事件处理器","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"esc":{"name":"### esc\n","description":"仅在 `key` 为 `Escape` 时调用事件处理器（keycode 为 27）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"space":{"name":"### space\n","description":"仅在 `key` 为 `Space` 时调用事件处理器（keycode 为 32）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"up":{"name":"### up\n","description":"仅在 `key` 为 `ArrowUp` 时调用事件处理器（keycode 为 38）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"down":{"name":"### down\n","description":"仅在 `key` 为 `ArrowDown` 时调用事件处理器（keycode 为 40）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"left":{"name":"### left\n","description":"仅在 `key` 为 `ArrowLeft` 时调用事件处理器（keycode 为 37）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"right":{"name":"### right\n","description":"仅在 `key` 为 `ArrowRight` 时调用事件处理器（keycode 为 39）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"}},"mouseModifiers":{"left":{"name":"### left\n","description":"单击鼠标左键时触发鼠标事件。","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"right":{"name":"### right\n","description":"单击鼠标右键时触发鼠标事件","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"middle":{"name":"### middle\n","description":"单击鼠标中键（滚轮）时触发鼠标事件","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"}},"systemModifiers":{"ctrl":{"name":"### ctrl\n","description":"当按下 \\ 时触发鼠标或键盘事件。","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"alt":{"name":"### alt\n","description":"当按下 \\ 时触发鼠标或键盘事件。","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"shift":{"name":"### shift\n","description":"当按下 \\ 时触发鼠标或键盘事件。","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"meta":{"name":"### meta\n","description":"当按下 \\ 时触发鼠标或键盘事件。","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"exact":{"name":"### exact\n","description":"`.exact` 修饰符允许控制触发事件所需的系统修饰符的精确组合。","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"}},"propsModifiers":{"sync":{"name":"### sync\n","description":"","compatibility":""}},"vModelModifiers":{"lazy":{"name":"### lazy\n","description":"默认情况下，`v-model` 会在每次 `input` 事件后更新数据 (IME 拼字阶段的状态例外)。你可以添加 `lazy` 修饰符来改为在每次 `change` 事件后更新数据","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | x |"},"number":{"name":"### number\n","description":"如果你想让用户输入自动转换为数字，你可以在 `v-model` 后添加 `.number` 修饰符来管理输入","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |"},"trim":{"name":"### trim\n","description":"如果你想要默认自动去除用户输入内容中两端的空格，你可以在 `v-model` 后添加 `.trim` 修饰符","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |"}},"E_App":{"example":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/App.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#"}},"E_type":{"type":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/type/type.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/type/type"}},"E_app-instance":{"component_component":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/app-instance/component/component.uvue","code":"```vue\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/app-instance/component/component"},"globalProperties_globalProperties-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/app-instance/globalProperties/globalProperties-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/app-instance/globalProperties/globalProperties-composition"},"globalProperties_globalProperties-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/app-instance/globalProperties/globalProperties-options.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/app-instance/globalProperties/globalProperties-options"},"use_use-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/app-instance/use/use-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/app-instance/use/use-composition"},"use_use-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/app-instance/use/use-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/app-instance/use/use-options"}},"E_component-instance":{"attrs_attrs-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/attrs/attrs-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/attrs/attrs-composition"},"attrs_attrs-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/attrs/attrs-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/attrs/attrs-options"},"attrs_child-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/attrs/child-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/attrs/child-composition"},"attrs_child-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/attrs/child-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/attrs/child-options"},"circular-reference_ChildA-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/circular-reference/ChildA-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/circular-reference/ChildA-composition"},"circular-reference_ChildA-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/circular-reference/ChildA-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/circular-reference/ChildA-options"},"circular-reference_ChildB-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/circular-reference/ChildB-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/circular-reference/ChildB-composition"},"circular-reference_ChildB-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/circular-reference/ChildB-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/circular-reference/ChildB-options"},"circular-reference_ChildC-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/circular-reference/ChildC-composition.uvue","code":"```vue\n\r\n\r\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/circular-reference/ChildC-composition"},"circular-reference_ChildC-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/circular-reference/ChildC-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/circular-reference/ChildC-options"},"circular-reference_circular-reference-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/circular-reference/circular-reference-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/circular-reference/circular-reference-composition"},"circular-reference_circular-reference-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/circular-reference/circular-reference-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/circular-reference/circular-reference-options"},"data_data-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/data/data-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/data/data-composition"},"data_data-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/data/data-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/data/data-options"},"define-expose_define-expose":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/define-expose/define-expose.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/define-expose/define-expose"},"el_el-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/el/el-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/el/el-composition"},"el_el-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/el/el-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/el/el-options"},"emit-function_child-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/emit-function/child-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/emit-function/child-composition"},"emit-function_child-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/emit-function/child-options.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/emit-function/child-options"},"emit-function_emit-function-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/emit-function/emit-function-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/emit-function/emit-function-composition"},"emit-function_emit-function-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/emit-function/emit-function-options.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/emit-function/emit-function-options"},"force-update_force-update-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/force-update/force-update-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/force-update/force-update-composition"},"force-update_force-update-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/force-update/force-update-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/force-update/force-update-options"},"inject_inject-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/inject/inject-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/inject/inject-composition"},"inject_inject-options-1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/inject/inject-options-1.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/inject/inject-options-1"},"inject_inject-options-2":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/inject/inject-options-2.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/inject/inject-options-2"},"methods_call-method-define-expose":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-define-expose.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-define-expose"},"methods_call-method-easycom-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-easycom-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-easycom-composition"},"methods_call-method-easycom-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-easycom-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-easycom-options"},"methods_call-method-easycom-uni-modules-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-easycom-uni-modules-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-easycom-uni-modules-composition"},"methods_call-method-easycom-uni-modules-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-easycom-uni-modules-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-easycom-uni-modules-options"},"methods_call-method-other-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-other-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-other-composition"},"methods_call-method-other-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-other-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-other-options"},"methods_call-method-uni-element-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-uni-element-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-uni-element-composition"},"methods_call-method-uni-element-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-uni-element-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-uni-element-options"},"methods_component-define-expose":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/component-define-expose.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/component-define-expose"},"methods_component1-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/component1-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/component1-composition"},"methods_component1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/component1.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/component1"},"mixins_mixins-app-page-namesake":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/mixins-app-page-namesake.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/mixins-app-page-namesake"},"mixins_mixins-app":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/mixins-app.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/mixins-app"},"mixins_mixins-web":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/mixins-web.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/mixins-web"},"nextTick_child-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/nextTick/child-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/nextTick/child-composition"},"nextTick_child-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/nextTick/child-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/nextTick/child-options"},"nextTick_nextTick-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/nextTick/nextTick-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/nextTick/nextTick-composition"},"nextTick_nextTick-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/nextTick/nextTick-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/nextTick/nextTick-options"},"options_options-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/options/options-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/options/options-composition"},"options_options-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/options/options-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/options/options-options"},"parent_child-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/parent/child-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/parent/child-composition"},"parent_child-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/parent/child-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/parent/child-options"},"parent_parent-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/parent/parent-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/parent/parent-composition"},"parent_parent-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/parent/parent-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/parent/parent-options"},"props_array-literal-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/array-literal-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/array-literal-composition"},"props_array-literal-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/array-literal-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/array-literal-options"},"props_object-type-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/object-type-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/object-type-composition"},"props_object-type-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/object-type-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/object-type-options"},"props_props-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/props-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/props-composition"},"props_props-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/props-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/props-options"},"props_props-with-defaults":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/props-with-defaults.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/props-with-defaults"},"props_same-name-prop-default-value-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/same-name-prop-default-value-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/same-name-prop-default-value-composition"},"props_same-name-prop-default-value-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/same-name-prop-default-value-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/same-name-prop-default-value-options"},"provide_provide-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/provide/provide-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/provide/provide-composition"},"provide_provide-options-1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/provide/provide-options-1.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/provide/provide-options-1"},"provide_provide-options-2":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/provide/provide-options-2.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/provide/provide-options-2"},"refs_child-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/refs/child-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/refs/child-composition"},"refs_child-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/refs/child-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/refs/child-options"},"refs_refs-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/refs/refs-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/refs/refs-composition"},"refs_refs-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/refs/refs-options.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/refs/refs-options"},"root_child-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/root/child-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/root/child-composition"},"root_child-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/root/child-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/root/child-options"},"root_root-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/root/root-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/root/root-composition"},"root_root-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/root/root-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/root/root-options"},"setup-function_Foo":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/setup-function/Foo.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/setup-function/Foo"},"setup-function_RenderFunction":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/setup-function/RenderFunction.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/setup-function/RenderFunction"},"setup-function_setup-function":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/setup-function/setup-function.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/setup-function/setup-function"},"slots_slot-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/slots/slot-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/slots/slot-composition"},"slots_slot-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/slots/slot-options.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/slots/slot-options"},"slots_slots-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/slots/slots-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/slots/slots-composition"},"slots_slots-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/slots/slots-options.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/slots/slots-options"},"mixins_components_ChildMixinComp1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/ChildMixinComp1.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/ChildMixinComp1"},"mixins_components_ChildMixinComp2":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/ChildMixinComp2.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/ChildMixinComp2"},"mixins_components_Comp1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/Comp1.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/Comp1"},"mixins_components_Comp2":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/Comp2.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/Comp2"},"mixins_components_CompForComp":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/CompForComp.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/CompForComp"},"mixins_components_CompForPage":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/CompForPage.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/CompForPage"},"mixins_components_GlobalChildMixinComp1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/GlobalChildMixinComp1.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/GlobalChildMixinComp1"},"mixins_components_GlobalChildMixinComp2":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/GlobalChildMixinComp2.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/GlobalChildMixinComp2"},"mixins_components_GlobalMixinComp1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/GlobalMixinComp1.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/GlobalMixinComp1"},"mixins_components_GlobalMixinComp2":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/GlobalMixinComp2.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/GlobalMixinComp2"},"mixins_components_MixinComp1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/MixinComp1.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/MixinComp1"},"mixins_components_MixinComp2":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/MixinComp2.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/MixinComp2"},"mixins_components_MixinCompForChildMixin":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/MixinCompForChildMixin.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/MixinCompForChildMixin"},"mixins_components_MixinCompForGlobalChildMixin":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/MixinCompForGlobalChildMixin.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/MixinCompForGlobalChildMixin"},"mixins_components_MixinCompForGlobalMixin":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/MixinCompForGlobalMixin.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/MixinCompForGlobalMixin"},"mixins_components_MixinCompForMixin":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/MixinCompForMixin.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/MixinCompForMixin"}},"E_directive":{"v-bind_Foo-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-bind/Foo-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-bind/Foo-composition"},"v-bind_Foo-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-bind/Foo-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-bind/Foo-options"},"v-bind_v-bind-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-bind/v-bind-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-bind/v-bind-composition"},"v-bind_v-bind-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-bind/v-bind-options.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-bind/v-bind-options"},"v-for_v-for-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-for/v-for-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-for/v-for-composition"},"v-for_v-for-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-for/v-for-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-for/v-for-options"},"v-html_v-html-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-html/v-html-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-html/v-html-composition"},"v-html_v-html-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-html/v-html-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-html/v-html-options"},"v-if_v-if-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-if/v-if-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-if/v-if-composition"},"v-if_v-if-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-if/v-if-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-if/v-if-options"},"v-memo_v-memo-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-memo/v-memo-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-memo/v-memo-composition"},"v-memo_v-memo-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-memo/v-memo-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-memo/v-memo-options"},"v-model_Foo-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-model/Foo-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-model/Foo-composition"},"v-model_v-model-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-model/v-model-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-model/v-model-composition"},"v-model_v-model-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-model/v-model-options.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-model/v-model-options"},"v-on_v-on-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-on/v-on-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-on/v-on-composition"},"v-on_v-on-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-on/v-on-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-on/v-on-options"},"v-once_v-once-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-once/v-once-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-once/v-once-composition"},"v-once_v-once-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-once/v-once-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-once/v-once-options"},"v-pre_v-pre":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-pre/v-pre.uvue","code":"```vue\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-pre/v-pre"},"v-show_v-show-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-show/v-show-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-show/v-show-composition"},"v-show_v-show-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-show/v-show-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-show/v-show-options"},"v-slot_Foo-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-slot/Foo-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-slot/Foo-composition"},"v-slot_Foo-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-slot/Foo-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-slot/Foo-options"},"v-slot_v-slot-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-slot/v-slot-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-slot/v-slot-composition"},"v-slot_v-slot-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-slot/v-slot-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-slot/v-slot-options"},"v-text_v-text-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-text/v-text-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-text/v-text-composition"},"v-text_v-text-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-text/v-text-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-text/v-text-options"}},"E_error":{"runtime-error_runtime-error-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/error/runtime-error/runtime-error-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/error/runtime-error/runtime-error-composition"},"runtime-error_runtime-error-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/error/runtime-error/runtime-error-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/error/runtime-error/runtime-error-options"}},"E_examples":{"nested-component-communication_nested-component-communication-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/examples/nested-component-communication/nested-component-communication-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/examples/nested-component-communication/nested-component-communication-composition"},"nested-component-communication_nested-component-communication-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/examples/nested-component-communication/nested-component-communication-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/examples/nested-component-communication/nested-component-communication-options"},"set-custom-child-component-root-node-class_child":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/examples/set-custom-child-component-root-node-class/child.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/examples/set-custom-child-component-root-node-class/child"},"set-custom-child-component-root-node-class_set-custom-child-component-root-node-class-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/examples/set-custom-child-component-root-node-class/set-custom-child-component-root-node-class-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/examples/set-custom-child-component-root-node-class/set-custom-child-component-root-node-class-composition"},"set-custom-child-component-root-node-class_set-custom-child-component-root-node-class-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/examples/set-custom-child-component-root-node-class/set-custom-child-component-root-node-class-options.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/examples/set-custom-child-component-root-node-class/set-custom-child-component-root-node-class-options"},"unrecognized-component_unrecognized-component":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/examples/unrecognized-component/unrecognized-component.uvue","code":"```vue\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/examples/unrecognized-component/unrecognized-component"},"nested-component-communication_components_child":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/examples/nested-component-communication/components/child.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/examples/nested-component-communication/components/child"},"nested-component-communication_components_grandChild":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/examples/nested-component-communication/components/grandChild.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/examples/nested-component-communication/components/grandChild"}},"E_lifecycle":{"component_ChildComponentComposition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/lifecycle/component/ChildComponentComposition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/lifecycle/component/ChildComponentComposition"},"component_ChildComponentOptions":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/lifecycle/component/ChildComponentOptions.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/lifecycle/component/ChildComponentOptions"},"component_component-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/lifecycle/component/component-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/lifecycle/component/component-composition"},"component_component-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/lifecycle/component/component-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/lifecycle/component/component-options"},"page_monitor-page-lifecycle-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/lifecycle/page/monitor-page-lifecycle-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/lifecycle/page/monitor-page-lifecycle-composition"},"page_monitor-page-lifecycle-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/lifecycle/page/monitor-page-lifecycle-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/lifecycle/page/monitor-page-lifecycle-options"},"page_page-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/lifecycle/page/page-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/lifecycle/page/page-composition"},"page_page-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/lifecycle/page/page-options.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/lifecycle/page/page-options"}},"E_render-function":{"cloneVNode_cloneVNode-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/cloneVNode/cloneVNode-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/cloneVNode/cloneVNode-composition"},"cloneVNode_cloneVNode-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/cloneVNode/cloneVNode-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/cloneVNode/cloneVNode-options"},"isVNode_isVNode-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/isVNode/isVNode-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/isVNode/isVNode-composition"},"isVNode_isVNode-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/isVNode/isVNode-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/isVNode/isVNode-options"},"mergeProps_mergeProps-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/mergeProps/mergeProps-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/mergeProps/mergeProps-composition"},"mergeProps_mergeProps-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/mergeProps/mergeProps-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/mergeProps/mergeProps-options"},"render_render-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/render/render-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/render/render-composition"},"render_render-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/render/render-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/render/render-options"},"resolveComponent_resolveComponent-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/resolveComponent/resolveComponent-composition.uvue","code":"```vue\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/resolveComponent/resolveComponent-composition"},"resolveComponent_resolveComponent-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/resolveComponent/resolveComponent-options.uvue","code":"```vue\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/resolveComponent/resolveComponent-options"},"withDirectives_withDirectives-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/withDirectives/withDirectives-composition.uvue","code":"```vue\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/withDirectives/withDirectives-composition"},"withDirectives_withDirectives-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/withDirectives/withDirectives-options.uvue","code":"```vue\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/withDirectives/withDirectives-options"},"withModifiers_withModifiers-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/withModifiers/withModifiers-composition.uvue","code":"```vue\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/withModifiers/withModifiers-composition"},"withModifiers_withModifiers-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/withModifiers/withModifiers-options.uvue","code":"```vue\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/withModifiers/withModifiers-options"}},"E_built-in":{"component_keep-alive_keep-alive-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/component/keep-alive/keep-alive-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/component/keep-alive/keep-alive-composition"},"component_keep-alive_keep-alive-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/component/keep-alive/keep-alive-options.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/component/keep-alive/keep-alive-options"},"component_teleport_teleport-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/component/teleport/teleport-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/component/teleport/teleport-composition"},"component_teleport_teleport-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/component/teleport/teleport-options.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/component/teleport/teleport-options"},"special-elements_component_component-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/component/component-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/component/component-composition"},"special-elements_component_component-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/component/component-options.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/component/component-options"},"special-elements_slots_child-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/slots/child-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/slots/child-composition"},"special-elements_slots_child-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/slots/child-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/slots/child-options"},"special-elements_slots_slots-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/slots/slots-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/slots/slots-composition"},"special-elements_slots_slots-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/slots/slots-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/slots/slots-options"},"special-elements_template_template-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/template/template-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/template/template-composition"},"special-elements_template_template-map-style-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/template/template-map-style-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/template/template-map-style-composition"},"special-elements_template_template-map-style-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/template/template-map-style-options.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/template/template-map-style-options"},"special-elements_template_template-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/template/template-options.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/template/template-options"}},"E_reactivity":{"advanced_custom-ref_custom-ref":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/custom-ref/custom-ref.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/custom-ref/custom-ref"},"advanced_effect-scope_effect-scope":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/effect-scope/effect-scope.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/effect-scope/effect-scope"},"advanced_get-current-scope_get-current-scope":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/get-current-scope/get-current-scope.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/get-current-scope/get-current-scope"},"advanced_mark-raw_mark-raw":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/mark-raw/mark-raw.uvue","code":"```vue\n \n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/mark-raw/mark-raw"},"advanced_on-scope-dispose_on-scope-dispose":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/on-scope-dispose/on-scope-dispose.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/on-scope-dispose/on-scope-dispose"},"advanced_shallow-reactive_shallow-reactive":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/shallow-reactive/shallow-reactive.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/shallow-reactive/shallow-reactive"},"advanced_shallow-readonly_shallow-readonly":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/shallow-readonly/shallow-readonly.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/shallow-readonly/shallow-readonly"},"advanced_shallow-ref_shallow-ref":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/shallow-ref/shallow-ref.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/shallow-ref/shallow-ref"},"advanced_to-raw_to-raw":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/to-raw/to-raw.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/to-raw/to-raw"},"advanced_trigger-ref_trigger-ref":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/trigger-ref/trigger-ref.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/trigger-ref/trigger-ref"},"core_computed_computed-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/computed/computed-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/computed/computed-composition"},"core_computed_computed-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/computed/computed-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/computed/computed-options"},"core_reactive_reactive":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/reactive/reactive.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/reactive/reactive"},"core_readonly_readonly":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/readonly/readonly.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/readonly/readonly"},"core_ref_ref":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/ref/ref.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/ref/ref"},"core_watch_watch-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/watch/watch-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/watch/watch-composition"},"core_watch_watch-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/watch/watch-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/watch/watch-options"},"core_watch-effect_watch-effect":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/watch-effect/watch-effect.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/watch-effect/watch-effect"},"core_watch-post-effect_watch-post-effect":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/watch-post-effect/watch-post-effect.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/watch-post-effect/watch-post-effect"},"core_watch-sync-effect_watch-sync-effect":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/watch-sync-effect/watch-sync-effect.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/watch-sync-effect/watch-sync-effect"},"utilities_is-proxy_is-proxy":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/utilities/is-proxy/is-proxy.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/utilities/is-proxy/is-proxy"},"utilities_is-reactive_is-reactive":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/utilities/is-reactive/is-reactive.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/utilities/is-reactive/is-reactive"},"utilities_is-readonly_is-readonly":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/utilities/is-readonly/is-readonly.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/utilities/is-readonly/is-readonly"},"utilities_is-ref_is-ref":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/utilities/is-ref/is-ref.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/utilities/is-ref/is-ref"},"utilities_to-ref_to-ref":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/utilities/to-ref/to-ref.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/utilities/to-ref/to-ref"},"utilities_to-refs_to-refs":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/utilities/to-refs/to-refs.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/utilities/to-refs/to-refs"},"utilities_to-value_to-value":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/utilities/to-value/to-value.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/utilities/to-value/to-value"},"utilities_un-ref_un-ref":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/utilities/un-ref/un-ref.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/utilities/un-ref/un-ref"}},"E_components":{"Bar":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/Bar.uvue","code":"```vue\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/Bar"},"CompForAppComponent":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/CompForAppComponent.uvue","code":"```vue\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/CompForAppComponent"},"CompForAppUse":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/CompForAppUse.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/CompForAppUse"},"CompForHFunction":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/CompForHFunction.uvue","code":"```vue\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/CompForHFunction"},"CompForPlugin":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/CompForPlugin.uvue","code":"```vue\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/CompForPlugin"},"Foo":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/Foo.uvue","code":"```vue\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/Foo"},"define-expose-foo_define-expose-foo":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/define-expose-foo/define-expose-foo.uvue","code":"```vue\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/define-expose-foo/define-expose-foo"},"keep-alive_Counter":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/keep-alive/Counter.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/keep-alive/Counter"},"keep-alive_Message":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/keep-alive/Message.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/keep-alive/Message"},"keep-alive_ShouldExclude":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/keep-alive/ShouldExclude.uvue","code":"```vue\n\r\n\r\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/keep-alive/ShouldExclude"},"test-type_test-type":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/test-type/test-type.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/test-type/test-type"},"test-type1_test-type1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/test-type1/test-type1.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/test-type1/test-type1"}}} +{"template":{"name":"#### template","description":"","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| lang | string | - | | |\n@| 值名称 | 兼容性 | 描述 |\n@| :- | :-: | :- |\n@| html | - | html |\n@| pug | - | 仅 Web 端支持 |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","children":"","reference":""},"slot":{"name":"#### slot","description":"> 组件类型：string \n\n \\ 元素作为组件模板之中的内容分发插槽。\\ 元素自身将被替换。","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| name | string | - | - | 用于命名插槽。 |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","children":"","reference":"\n##### 参见\n- [Reference](https://v3.cn.vuejs.org/api/built-in-components.html#slot)\n"},"script":{"name":"#### script","description":"","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| setup | Any | - | | - |\n| lang | Any | - | | |\n@| 值名称 | 兼容性 | 描述 |\n@| :- | :-: | :- |\n@| uts | | uts |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","children":"","reference":""},"style":{"name":"#### style","description":"","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| lang | string | - | | |\n@| 值名称 | 兼容性 | 描述 |\n@| :- | :-: | :- |\n@| scss | - | - |\n@| less | - | - |\n@| stylus | - | - |\n| scoped | Any | - | | - |\n| module | Any | - | | - |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |\n","children":"","reference":""},"keep-alive":{"name":"#### keep-alive","description":"> 组件类型：string \n\n \\ 包裹动态组件时，会缓存不活动的组件实例，而不是销毁它们。和 \\ 相似，\\ 是一个抽象组件：它自身不会渲染一个 DOM 元素，也不会出现在父组件链中。","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| include | string | - | - | 字符串或正则表达式。只有名称匹配的组件会被缓存。 |\n| exclude | string | - | - | 字符串或正则表达式。任何名称匹配的组件都不会被缓存。 |\n| max | string | - | - | 最多可以缓存多少组件实例。 |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| 4.0 | 4.11 | 4.0 |\n","children":"","reference":"\n##### 参见\n- [Reference](https://v3.cn.vuejs.org/api/built-in-components.html#keep-alive)\n"},"component":{"name":"#### component","description":"> 组件类型：string \n\n 渲染一个“元组件”为动态组件。依 is 的值，来决定哪个组件被渲染。","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| is | Any | - | - | - |\n| inline-template | Any | - | - | - |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| 3.99 | 4.11 | 4.0 |\n","children":"","reference":"\n##### 参见\n- [Reference](https://v3.cn.vuejs.org/api/built-in-components.html#component)\n"},"transition":{"name":"#### transition","description":"> 组件类型：string \n\n \\ 元素作为单个元素/组件的过渡效果。\\ 只会把过渡效果应用到其包裹的内容上，而不会额外渲染 DOM 元素，也不会出现在检测过的组件层级中。","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| name | string | - | - | 用于自动生成 CSS 过渡类名。例如：name: 'fade' 将自动拓展为.fade-enter，.fade-enter-active等。默认类名为 \"v\" |\n| appear | string(true \\| false) | - | - | 是否在初始渲染时使用过渡。默认为 false。 |\n| css | string(true \\| false) | - | - | 是否使用 CSS 过渡类。默认为 true。如果设置为 false，将只通过组件事件触发注册的 JavaScript 钩子。 |\n| type | string | - | - | 指定过渡事件类型，侦听过渡何时结束。有效值为 \"transition\" 和 \"animation\"。默认 Vue.js 将自动检测出持续时间长的为过渡事件类型。 |\n@| 值名称 | 兼容性 | 描述 |\n@| :- | :-: | :- |\n@| transition | - | - |\n@| animation | - | - |\n| mode | string | - | - | 控制离开/进入的过渡时间序列。有效的模式有 \"out-in\" 和 \"in-out\"；默认同时生效。 |\n@| 值名称 | 兼容性 | 描述 |\n@| :- | :-: | :- |\n@| out-in | - | - |\n@| in-out | - | - |\n| duration | string | - | - | 指定过渡的持续时间。默认情况下，Vue 会等待过渡所在根元素的第一个 transitionend 或 animationend 事件。 |\n| enter-class | Any | - | - | - |\n| leave-class | Any | - | - | - |\n| appear-class | Any | - | - | - |\n| enter-to-class | Any | - | - | - |\n| leave-to-class | Any | - | - | - |\n| appear-to-class | Any | - | - | - |\n| enter-active-class | Any | - | - | - |\n| leave-active-class | Any | - | - | - |\n| appear-active-class | Any | - | - | - |\n| @before-enter | Any | - | - | - |\n| @before-leave | Any | - | - | - |\n| @before-appear | Any | - | - | - |\n| @enter | Any | - | - | - |\n| @leave | Any | - | - | - |\n| @appear | Any | - | - | - |\n| @after-enter | Any | - | - | - |\n| @after-leave | Any | - | - | - |\n| @after-appear | Any | - | - | - |\n| @enter-cancelled | Any | - | - | - |\n| @leave-cancelled | string | - | - | v-show only |\n| @appear-cancelled | Any | - | - | - |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |\n","children":"","reference":"\n##### 参见\n- [Reference](https://v3.cn.vuejs.org/api/built-in-components.html#transition)\n"},"transition-group":{"name":"#### transition-group","description":"> 组件类型：string \n\n \\ 元素作为多个元素/组件的过渡效果。\\ 渲染一个真实的 DOM 元素。默认渲染 \\，可以通过 tag 属性配置哪个元素应该被渲染。","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| tag | string | - | - | 默认为 span。 |\n| move-class | string | - | - | 覆盖移动过渡期间应用的 CSS 类。 |\n| name | string | - | - | 用于自动生成 CSS 过渡类名。例如：name: 'fade' 将自动拓展为.fade-enter，.fade-enter-active等。默认类名为 \"v\" |\n| appear | string(true \\| false) | - | - | 是否在初始渲染时使用过渡。默认为 false。 |\n| css | string(true \\| false) | - | - | 是否使用 CSS 过渡类。默认为 true。如果设置为 false，将只通过组件事件触发注册的 JavaScript 钩子。 |\n| type | string | - | - | 指定过渡事件类型，侦听过渡何时结束。有效值为 \"transition\" 和 \"animation\"。默认 Vue.js 将自动检测出持续时间长的为过渡事件类型。 |\n@| 值名称 | 兼容性 | 描述 |\n@| :- | :-: | :- |\n@| transition | - | - |\n@| animation | - | - |\n| mode | Any | - | - | - |\n| duration | string | - | - | 指定过渡的持续时间。默认情况下，Vue 会等待过渡所在根元素的第一个 transitionend 或 animationend 事件。 |\n| enter-class | Any | - | - | - |\n| leave-class | Any | - | - | - |\n| appear-class | Any | - | - | - |\n| enter-to-class | Any | - | - | - |\n| leave-to-class | Any | - | - | - |\n| appear-to-class | Any | - | - | - |\n| enter-active-class | Any | - | - | - |\n| leave-active-class | Any | - | - | - |\n| appear-active-class | Any | - | - | - |\n| @before-enter | Any | - | - | - |\n| @before-leave | Any | - | - | - |\n| @before-appear | Any | - | - | - |\n| @enter | Any | - | - | - |\n| @leave | Any | - | - | - |\n| @appear | Any | - | - | - |\n| @after-enter | Any | - | - | - |\n| @after-leave | Any | - | - | - |\n| @after-appear | Any | - | - | - |\n| @enter-cancelled | Any | - | - | - |\n| @leave-cancelled | string | - | - | v-show only |\n| @appear-cancelled | Any | - | - | - |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |\n","children":"","reference":"\n##### 参见\n- [Reference](https://v3.cn.vuejs.org/api/built-in-components.html#transition-group)\n"},"teleport":{"name":"#### teleport","description":"> 组件类型：string \n\n Teleport 提供了一种干净的方法，允许我们控制在 DOM 中哪个父节点下呈现 HTML，而不必求助于全局状态或将其拆分为两个组件。","attribute":"##### 属性 \n| 名称 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :-: | :- |\n| to | string | - | - | 必须是有效的查询选择器或 HTMLElement (如果在浏览器环境中使用)。指定将在其中移动 \\ 内容的目标元素 |\n| disabled | boolean | - | - | 此可选属性可用于禁用 \\ 的功能，这意味着其插槽内容将不会移动到任何位置，而是在您在周围父组件中指定了 \\ 的位置渲染。 |","event":"","example":"","compatibility":"\n##### 兼容性\n| Android | iOS | web |\n| :- | :- | :- |\n| 4.0 | 4.11 | 4.0 |\n","children":"","reference":"\n##### 参见\n- [Reference](https://v3.vuejs.org/api/built-in-components.html#teleport)\n"},"application":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| createApp() | √ | 4.11 | 4.0 |\n| createSSRApp() | √ | 4.11 | 4.0 |\n| app.mount() | √ | 4.11 | 4.0 |\n| app.unmount() | √ | 4.11 | 4.0 |\n| app.component() | √ | 4.11 | 4.0 |\n| app.directive() | - | - | - |\n| app.use() | 3.99 | 4.11 | 4.0 |\n| app.mixin() | 3.99 | 4.11 | 4.0 |\n| app.provide() | 3.99 | 4.11 | 4.0 |\n| app.runWithContext() | - | - | - |\n| app.version | √ | 4.11 | 4.0 |\n| app.config | - | - | - |\n| app.config.errorHandler | x | 4.11 | 4.0 |\n| app.config.warnHandler | - | - | - |\n| app.config.performance | - | - | - |\n| app.config.compilerOptions | - | - | - |\n| app.config.globalProperties | 3.99 | 4.11 | 4.0 |\n| app.config.optionMergeStrategies | - | - | - |","example":""},"general":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| version | √ | 4.11 | 4.0 |\n| nextTick() | √ | 4.11 | 4.0 |\n| defineComponent() | x | x | 4.0 |\n| defineAsyncComponent() | - | - | - |\n| defineCustomElement() | - | - | - |","example":""},"reactivity_core":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| ref() | √ | 4.11 | 4.0 |\n| computed() | - | - | - |\n| reactive() | √ | 4.11 | 4.0 |\n| readonly() | 4.0 | 4.11 | 4.0 |\n| watchEffect() | 4.0 | 4.11 | 4.0 |\n| watchPostEffect() | 4.0 | 4.11 | 4.0 |\n| watchSyncEffect() | 4.0 | 4.11 | 4.0 |\n| watch() | 4.0 | 4.11 | 4.0 |","example":""},"reactivity_utilities":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| isRef() | 4.0 | 4.11 | 4.0 |\n| unref() | 4.0 | 4.11 | 4.0 |\n| toRef() | 4.0 | 4.11 | 4.11 |\n| toValue() | 4.0 | 4.11 | 4.11 |\n| toRefs() | 4.0 | 4.11 | 4.11 |\n| isProxy() | 4.0 | 4.11 | 4.0 |\n| isReactive() | 4.0 | 4.11 | 4.0 |\n| isReadonly() | 4.0 | 4.11 | 4.0 |","example":""},"reactivity_advanced":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| shallowRef() | 4.0 | 4.11 | 4.0 |\n| triggerRef() | 4.0 | 4.11 | x |\n| customRef() | 4.0 | 4.11 | 4.0 |\n| shallowReactive() | 4.0 | 4.11 | 4.0 |\n| shallowReadonly() | 4.0 | 4.11 | 4.0 |\n| toRaw() | 4.0 | 4.11 | 4.0 |\n| markRaw() | - | - | - |\n| effectScope() | 4.0 | 4.11 | 4.0 |\n| getCurrentScope() | 4.0 | 4.11 | 4.0 |\n| onScopeDispose() | 4.0 | 4.11 | 4.0 |","example":""},"composition_lifecycle":{"compatibility":"| | Android | iOS | web | 描述 |\n| :- | :- | :- | :- | :- |\n| onMounted() | 4.0 | 4.11 | 4.0 | el 被新创建的 vm.$el 替换，并挂载到实例上去之后调用该钩子。
如果 root 实例挂载了一个文档内元素，当 onMounted 被调用时 vm.$el 也在文档内。 |\n| onUpdated() | 4.0 | 4.11 | 4.0 | 由于数据更改导致的虚拟 DOM 重新渲染和打补丁，在这之后会调用该钩子。 |\n| onUnmounted() | 4.0 | 4.11 | 4.0 | 卸载组件实例后调用。
调用此钩子时，组件实例的所有指令都被解除绑定，所有事件侦听器都被移除，所有子组件实例被卸载。 |\n| onBeforeMount() | 4.0 | 4.11 | 4.0 | 在挂载开始之前被调用：相关的 render 函数首次被调用。 |\n| onBeforeUpdate() | 4.0 | 4.11 | 4.0 | 数据更新时调用，发生在虚拟 DOM 打补丁之前。
这里适合在更新之前访问现有的 DOM，比如手动移除已添加的事件监听器。 |\n| onBeforeUnmount() | 4.0 | 4.11 | 4.0 | 在卸载组件实例之前调用。在这个阶段，实例仍然是完全正常的。 |\n| onErrorCaptured() | x | x | x | 注册一个钩子，在捕获了后代组件传递的错误时调用。 |\n| onRenderTracked() | x | x | x | 注册一个调试钩子，当组件渲染过程中追踪到响应式依赖时调用。 |\n| onRenderTriggered() | x | x | x | 注册一个调试钩子，当响应式依赖的变更触发了组件渲染时调用。 |\n| onActivated() | x | x | 4.0 | keep-alive 组件激活时调用。 |\n| onDeactivated() | x | x | 4.0 | keep-alive 组件停用时调用。 |\n| onServerPrefetch() | x | x | x | 注册一个异步函数，在组件实例在服务器上被渲染之前调用。
如果这个钩子返回了一个 Promise，服务端渲染会在渲染该组件前等待该 Promise 完成。
这个钩子仅会在服务端渲染中执行，可以用于执行一些仅存在于服务端的数据抓取过程。 |","example":""},"composition_injection":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| provide() | 4.0 | 4.11 | 4.0 |\n| inject() | - | - | - |\n| hasInjectionContext() | 4.0 | 4.11 | 4.11 |","example":""},"options_state":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| data | 3.9 | 4.11 | 4.0 |\n| props | 3.9 | 4.11 | 4.0 |\n| computed | 3.9 | 4.11 | 4.0 |\n| methods | 3.9 | 4.11 | 4.0 |\n| watch | 3.9 | 4.11 | 4.0 |\n| emits | 3.9 | 4.11 | 4.0 |\n| expose | x | x | 4.0 |","example":""},"options_rendering":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| template | - | - | - |\n| render | 3.9 | 4.11 | 4.0 |\n| compilerOptions | - | - | - |\n| slots | 3.9 | 4.11 | 4.0 |","example":""},"options_lifecycle":{"compatibility":"| | Android | iOS | web | 描述 |\n| :- | :- | :- | :- | :- |\n| beforeCreate | 3.9 | 4.11 | 4.0 | 在组件实例初始化完成之后立即调用。
在实例初始化之后，数据观测 (data observer) 和 event/watcher 事件配置之前被调用。 |\n| created | 3.9 | 4.11 | 4.0 | 在组件实例处理完所有与状态相关的选项后调用。
在这一步，实例已完成以下的配置：数据观测 (data observer)，属性和方法的运算，watch/event 事件回调。
然而，此时挂载阶段还未开始，因此 $el 属性仍不可用。 |\n| beforeMount | 3.9 | 4.11 | 4.0 | 在组件被挂载之前调用。
相关的 render 函数首次被调用。
当这个钩子被调用时，组件已经完成了其响应式状态的设置，但还没有创建 DOM 节点。
它即将首次执行 DOM 渲染过程。 |\n| mounted | 3.9 | 4.11 | 4.0 | 在组件被挂载之后调用。
el 被新创建的 vm.$el 替换，并挂载到实例上去之后调用该钩子。
如果 root 实例挂载了一个文档内元素，当 mounted 被调用时 vm.$el 也在文档内。 |\n| beforeUpdate | 3.9 | 4.11 | 4.0 | 在组件即将因为一个响应式状态变更而更新其 DOM 树之前调用。
数据更新时调用，发生在虚拟 DOM 打补丁之前。
这里适合在更新之前访问现有的 DOM，比如手动移除已添加的事件监听器。 |\n| updated | 3.9 | 4.11 | 4.0 | 在组件因为一个响应式状态变更而更新其 DOM 树之后调用。
父组件的更新钩子将在其子组件的更新钩子之后调用。
这个钩子会在组件的任意 DOM 更新后被调用，这些更新可能是由不同的状态变更导致的。
如果你需要在某个特定的状态更改后访问更新后的 DOM，请使用 nextTick() 作为替代。 |\n| beforeUnmount | 3.9 | 4.11 | 4.0 | 在一个组件实例被卸载之前调用。
当这个钩子被调用时，组件实例依然还保有全部的功能。 |\n| unmounted | 3.9 | 4.11 | 4.0 | 在一个组件实例被卸载之后调用。
可以在这个钩子中手动清理一些副作用，例如计时器、DOM 事件监听器或者与服务器的连接。 |\n| errorCaptured | x | x | 4.0 | 在捕获了后代组件传递的错误时调用。
这个钩子带有三个实参：错误对象、触发该错误的组件实例，以及一个说明错误来源类型的信息字符串。
这个钩子可以通过返回 false 来阻止错误继续向上传递。 |\n| renderTracked | x | x | 4.0 | 在一个响应式依赖被组件的渲染作用追踪后调用。
跟踪虚拟 DOM 重新渲染时调用。钩子接收 debugger event 作为参数。
此事件告诉你哪个操作跟踪了组件以及该操作的目标对象和键。 |\n| renderTriggered | x | x | 4.0 | 在一个响应式依赖被组件触发了重新渲染之后调用。
当虚拟 DOM 重新渲染为 triggered.Similarly 为renderTracked，接收 debugger event 作为参数。
此事件告诉你是什么操作触发了重新渲染，以及该操作的目标对象和键。 |\n| activated | 4.0 | 4.11 | 4.0 | 若组件实例是 \\ 缓存树的一部分，当组件被插入到 DOM 中时调用。
keep-alive 组件激活时调用。 |\n| deactivated | 4.0 | 4.11 | 4.0 | 若组件实例是 \\ 缓存树的一部分，当组件从 DOM 中被移除时调用。
keep-alive 组件停用时调用。 |\n| serverPrefetch | - | - | - | - |","example":""},"options_composition":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| provide | 3.99 | 4.11 | 4.0 |\n| inject | 3.99 | 4.11 | 4.0 |\n| mixins | 3.99 | 4.11 | 4.0 |\n| extends | - | - | - |","example":""},"options_misc":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| name | 3.9 | 4.11 | 4.0 |\n| inheritAttrs | 3.9 | 4.11 | 4.0 |\n| components | 3.9 | 4.11 | 4.0 |\n| directives | - | - | - |","example":""},"component_instance":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| $data | √ | 4.11 | 4.0 |\n| $props | √ | 4.11 | 4.0 |\n| $el | √ | 4.11 | 4.0 |\n| $options | √ | 4.11 | 4.0 |\n| $parent | √ | 4.11 | 4.0 |\n| $root | √ | 4.11 | 4.0 |\n| $slots | √ | 4.11 | 4.0 |\n| $refs | √ | 4.11 | 4.0 |\n| $attrs | √ | 4.11 | 4.0 |\n| $watch() | √ | 4.11 | 4.0 |\n| $emit | √ | 4.11 | 4.0 |\n| $forceUpdate | √ | 4.11 | 4.0 |\n| $nextTick | √ | 4.11 | 4.0 |\n| $callMethod | √ | 4.11 | 4.0 |","example":""},"directives":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| v-text | x | x | 4.0 |\n| v-html | 3.99 | x | 4.0 |\n| v-show | 3.9 | 4.11 | 4.0 |\n| v-if | 3.9 | 4.11 | 4.0 |\n| v-else | 3.9 | 4.11 | 4.0 |\n| v-else-if | 3.9 | 4.11 | 4.0 |\n| v-for | 3.9 | 4.11 | 4.0 |\n| v-on | 3.9 | 4.11 | 4.0 |\n| v-bind | 3.9 | 4.11 | 4.0 |\n| v-model | 3.9 | 4.11 | 4.0 |\n| v-slot | 3.9 | 4.11 | 4.0 |\n| v-pre | 3.99 | 4.11 | 4.0 |\n| v-once | 3.99 | 4.11 | x |\n| v-memo | 3.99 | 4.11 | x |\n| v-cloak | x | x | 4.0 |","example":""},"special_attributes":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| key | 3.9 | 4.11 | 4.0 |\n| ref | 3.9 | 4.11 | 4.0 |\n| is | 3.99 | 4.11 | 4.0 |","example":""},"render_function":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| h() | 3.99 | 4.11 | 4.0 |\n| mergeProps() | 4.0 | 4.11 | 4.0 |\n| cloneVNode() | 4.0 | x | 4.0 |\n| isVNode() | √ | 4.11 | 4.0 |\n| resolveComponent() | √ | 4.11 | 4.0 |\n| resolveDirective() | - | - | - |\n| withDirectives() | x | 4.11 | 4.0 |\n| withModifiers() | √ | 4.11 | 4.0 |","example":""},"single_file_component_script":{"compatibility":"| | Android | iOS | web |\n| :- | :- | :- | :- |\n| defineProps() | 4.0 | 4.11 | 4.0 |\n| defineEmits() | 4.0 | 4.11 | 4.0 |\n| defineModel() | 4.0 | 4.11 | 4.11 |\n| defineExpose() | 4.0 | 4.11 | 4.0 |\n| defineOptions() | 4.0 | 4.11 | 4.11 |\n| defineSlots() | 4.0 | 4.11 | 4.0 |\n| useSlots() | 4.0 | 4.11 | 4.0 |\n| useAttrs() | 4.0 | 4.11 | 4.0 |","example":""},"eventModifiers":{"stop":{"name":"### stop\n","description":"单击事件将停止传递","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | 4.11 | 4.0 |"},"prevent":{"name":"### prevent\n","description":"提交事件将不再重新加载页面","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"capture":{"name":"### capture\n","description":"添加事件监听器时，使用 `capture` 捕获模式（例如：指向内部元素的事件，在被内部元素处理前，先被外部处理）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"self":{"name":"### self\n","description":"仅当 event.target 是元素本身时才会触发事件处理器（仅当 event.target 是元素本身时才会触发事件处理器）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"once":{"name":"### once\n","description":"点击事件最多被触发一次","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |"},"passive":{"name":"### passive\n","description":"滚动事件的默认行为 (scrolling) 将立即发生而非等待 `onScroll` 完成（滚动事件的默认行为 (scrolling) 将立即发生而非等待 `onScroll` 完成）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"}},"keyModifiers":{"enter":{"name":"### enter\n","description":"仅在 `key` 为 `Enter` 时调用事件处理器（keycode 为 13）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"tab":{"name":"### tab\n","description":"仅在 `key` 为 `Tab` 时调用事件处理器（keycode 为 9）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"delete":{"name":"### delete\n","description":"仅在 `key` 为 `Delete` 或 `Backspace` 时调用事件处理器","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"esc":{"name":"### esc\n","description":"仅在 `key` 为 `Escape` 时调用事件处理器（keycode 为 27）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"space":{"name":"### space\n","description":"仅在 `key` 为 `Space` 时调用事件处理器（keycode 为 32）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"up":{"name":"### up\n","description":"仅在 `key` 为 `ArrowUp` 时调用事件处理器（keycode 为 38）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"down":{"name":"### down\n","description":"仅在 `key` 为 `ArrowDown` 时调用事件处理器（keycode 为 40）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"left":{"name":"### left\n","description":"仅在 `key` 为 `ArrowLeft` 时调用事件处理器（keycode 为 37）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"right":{"name":"### right\n","description":"仅在 `key` 为 `ArrowRight` 时调用事件处理器（keycode 为 39）","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"}},"mouseModifiers":{"left":{"name":"### left\n","description":"单击鼠标左键时触发鼠标事件。","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"right":{"name":"### right\n","description":"单击鼠标右键时触发鼠标事件","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"middle":{"name":"### middle\n","description":"单击鼠标中键（滚轮）时触发鼠标事件","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"}},"systemModifiers":{"ctrl":{"name":"### ctrl\n","description":"当按下 \\ 时触发鼠标或键盘事件。","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"alt":{"name":"### alt\n","description":"当按下 \\ 时触发鼠标或键盘事件。","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"shift":{"name":"### shift\n","description":"当按下 \\ 时触发鼠标或键盘事件。","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"meta":{"name":"### meta\n","description":"当按下 \\ 时触发鼠标或键盘事件。","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"},"exact":{"name":"### exact\n","description":"`.exact` 修饰符允许控制触发事件所需的系统修饰符的精确组合。","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| x | x | 4.0 |"}},"propsModifiers":{"sync":{"name":"### sync\n","description":"","compatibility":""}},"vModelModifiers":{"lazy":{"name":"### lazy\n","description":"默认情况下，`v-model` 会在每次 `input` 事件后更新数据 (IME 拼字阶段的状态例外)。你可以添加 `lazy` 修饰符来改为在每次 `change` 事件后更新数据","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | x |"},"number":{"name":"### number\n","description":"如果你想让用户输入自动转换为数字，你可以在 `v-model` 后添加 `.number` 修饰符来管理输入","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |"},"trim":{"name":"### trim\n","description":"如果你想要默认自动去除用户输入内容中两端的空格，你可以在 `v-model` 后添加 `.trim` 修饰符","compatibility":"**兼容性** \n | Android | iOS | web |\n| :- | :- | :- |\n| 3.9 | x | 4.0 |"}},"E_App":{"example":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/App.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#"}},"E_type":{"type":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/type/type.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/type/type"}},"E_app-instance":{"component_component":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/app-instance/component/component.uvue","code":"```vue\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/app-instance/component/component"},"globalProperties_globalProperties-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/app-instance/globalProperties/globalProperties-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/app-instance/globalProperties/globalProperties-composition"},"globalProperties_globalProperties-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/app-instance/globalProperties/globalProperties-options.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/app-instance/globalProperties/globalProperties-options"},"use_use-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/app-instance/use/use-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/app-instance/use/use-composition"},"use_use-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/app-instance/use/use-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/app-instance/use/use-options"}},"E_component-instance":{"attrs_attrs-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/attrs/attrs-composition.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/attrs/attrs-composition"},"attrs_attrs-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/attrs/attrs-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/attrs/attrs-options"},"attrs_child-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/attrs/child-composition.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/attrs/child-composition"},"attrs_child-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/attrs/child-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/attrs/child-options"},"circular-reference_ChildA-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/circular-reference/ChildA-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/circular-reference/ChildA-composition"},"circular-reference_ChildA-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/circular-reference/ChildA-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/circular-reference/ChildA-options"},"circular-reference_ChildB-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/circular-reference/ChildB-composition.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/circular-reference/ChildB-composition"},"circular-reference_ChildB-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/circular-reference/ChildB-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/circular-reference/ChildB-options"},"circular-reference_ChildC-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/circular-reference/ChildC-composition.uvue","code":"```vue\n\r\n\r\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/circular-reference/ChildC-composition"},"circular-reference_ChildC-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/circular-reference/ChildC-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/circular-reference/ChildC-options"},"circular-reference_circular-reference-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/circular-reference/circular-reference-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/circular-reference/circular-reference-composition"},"circular-reference_circular-reference-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/circular-reference/circular-reference-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/circular-reference/circular-reference-options"},"data_data-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/data/data-composition.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/data/data-composition"},"data_data-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/data/data-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/data/data-options"},"define-expose_define-expose":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/define-expose/define-expose.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/define-expose/define-expose"},"el_el-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/el/el-composition.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/el/el-composition"},"el_el-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/el/el-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/el/el-options"},"emit-function_child-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/emit-function/child-composition.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/emit-function/child-composition"},"emit-function_child-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/emit-function/child-options.uvue","code":"```vue\n\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/emit-function/child-options"},"emit-function_emit-function-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/emit-function/emit-function-composition.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/emit-function/emit-function-composition"},"emit-function_emit-function-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/emit-function/emit-function-options.uvue","code":"```vue\n\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/emit-function/emit-function-options"},"force-update_force-update-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/force-update/force-update-composition.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/force-update/force-update-composition"},"force-update_force-update-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/force-update/force-update-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/force-update/force-update-options"},"inject_inject-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/inject/inject-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/inject/inject-composition"},"inject_inject-options-1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/inject/inject-options-1.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/inject/inject-options-1"},"inject_inject-options-2":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/inject/inject-options-2.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/inject/inject-options-2"},"methods_call-method-define-expose":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-define-expose.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-define-expose"},"methods_call-method-easycom-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-easycom-composition.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-easycom-composition"},"methods_call-method-easycom-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-easycom-options.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-easycom-options"},"methods_call-method-easycom-uni-modules-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-easycom-uni-modules-composition.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-easycom-uni-modules-composition"},"methods_call-method-easycom-uni-modules-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-easycom-uni-modules-options.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-easycom-uni-modules-options"},"methods_call-method-other-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-other-composition.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-other-composition"},"methods_call-method-other-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-other-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-other-options"},"methods_call-method-uni-element-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-uni-element-composition.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-uni-element-composition"},"methods_call-method-uni-element-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/call-method-uni-element-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/call-method-uni-element-options"},"methods_component-define-expose":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/component-define-expose.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/component-define-expose"},"methods_component1-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/component1-composition.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/component1-composition"},"methods_component1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/methods/component1.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/methods/component1"},"mixins_mixins-app-page-namesake":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/mixins-app-page-namesake.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/mixins-app-page-namesake"},"mixins_mixins-app":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/mixins-app.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/mixins-app"},"mixins_mixins-web":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/mixins-web.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/mixins-web"},"nextTick_child-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/nextTick/child-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/nextTick/child-composition"},"nextTick_child-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/nextTick/child-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/nextTick/child-options"},"nextTick_nextTick-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/nextTick/nextTick-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/nextTick/nextTick-composition"},"nextTick_nextTick-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/nextTick/nextTick-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/nextTick/nextTick-options"},"options_options-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/options/options-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/options/options-composition"},"options_options-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/options/options-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/options/options-options"},"parent_child-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/parent/child-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/parent/child-composition"},"parent_child-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/parent/child-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/parent/child-options"},"parent_parent-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/parent/parent-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/parent/parent-composition"},"parent_parent-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/parent/parent-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/parent/parent-options"},"props_array-literal-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/array-literal-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/array-literal-composition"},"props_array-literal-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/array-literal-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/array-literal-options"},"props_object-type-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/object-type-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/object-type-composition"},"props_object-type-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/object-type-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/object-type-options"},"props_props-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/props-composition.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/props-composition"},"props_props-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/props-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/props-options"},"props_props-with-defaults":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/props-with-defaults.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/props-with-defaults"},"props_same-name-prop-default-value-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/same-name-prop-default-value-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/same-name-prop-default-value-composition"},"props_same-name-prop-default-value-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/props/same-name-prop-default-value-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/props/same-name-prop-default-value-options"},"provide_provide-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/provide/provide-composition.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/provide/provide-composition"},"provide_provide-options-1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/provide/provide-options-1.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/provide/provide-options-1"},"provide_provide-options-2":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/provide/provide-options-2.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/provide/provide-options-2"},"refs_child-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/refs/child-composition.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/refs/child-composition"},"refs_child-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/refs/child-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/refs/child-options"},"refs_refs-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/refs/refs-composition.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/refs/refs-composition"},"refs_refs-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/refs/refs-options.uvue","code":"```vue\n\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/refs/refs-options"},"root_child-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/root/child-composition.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/root/child-composition"},"root_child-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/root/child-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/root/child-options"},"root_root-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/root/root-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/root/root-composition"},"root_root-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/root/root-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/root/root-options"},"setup-function_Foo":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/setup-function/Foo.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/setup-function/Foo"},"setup-function_RenderFunction":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/setup-function/RenderFunction.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/setup-function/RenderFunction"},"setup-function_setup-function":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/setup-function/setup-function.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/setup-function/setup-function"},"slots_slot-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/slots/slot-composition.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/slots/slot-composition"},"slots_slot-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/slots/slot-options.uvue","code":"```vue\n\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/slots/slot-options"},"slots_slots-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/slots/slots-composition.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/slots/slots-composition"},"slots_slots-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/slots/slots-options.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/slots/slots-options"},"mixins_components_ChildMixinComp1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/ChildMixinComp1.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/ChildMixinComp1"},"mixins_components_ChildMixinComp2":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/ChildMixinComp2.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/ChildMixinComp2"},"mixins_components_Comp1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/Comp1.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/Comp1"},"mixins_components_Comp2":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/Comp2.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/Comp2"},"mixins_components_CompForComp":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/CompForComp.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/CompForComp"},"mixins_components_CompForPage":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/CompForPage.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/CompForPage"},"mixins_components_GlobalChildMixinComp1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/GlobalChildMixinComp1.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/GlobalChildMixinComp1"},"mixins_components_GlobalChildMixinComp2":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/GlobalChildMixinComp2.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/GlobalChildMixinComp2"},"mixins_components_GlobalMixinComp1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/GlobalMixinComp1.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/GlobalMixinComp1"},"mixins_components_GlobalMixinComp2":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/GlobalMixinComp2.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/GlobalMixinComp2"},"mixins_components_MixinComp1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/MixinComp1.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/MixinComp1"},"mixins_components_MixinComp2":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/MixinComp2.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/MixinComp2"},"mixins_components_MixinCompForChildMixin":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/MixinCompForChildMixin.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/MixinCompForChildMixin"},"mixins_components_MixinCompForGlobalChildMixin":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/MixinCompForGlobalChildMixin.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/MixinCompForGlobalChildMixin"},"mixins_components_MixinCompForGlobalMixin":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/MixinCompForGlobalMixin.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/MixinCompForGlobalMixin"},"mixins_components_MixinCompForMixin":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/component-instance/mixins/components/MixinCompForMixin.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/component-instance/mixins/components/MixinCompForMixin"}},"E_directive":{"v-bind_Foo-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-bind/Foo-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-bind/Foo-composition"},"v-bind_Foo-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-bind/Foo-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-bind/Foo-options"},"v-bind_v-bind-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-bind/v-bind-composition.uvue","code":"```vue\n\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-bind/v-bind-composition"},"v-bind_v-bind-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-bind/v-bind-options.uvue","code":"```vue\n\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-bind/v-bind-options"},"v-for_v-for-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-for/v-for-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-for/v-for-composition"},"v-for_v-for-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-for/v-for-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-for/v-for-options"},"v-html_v-html-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-html/v-html-composition.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-html/v-html-composition"},"v-html_v-html-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-html/v-html-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-html/v-html-options"},"v-if_v-if-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-if/v-if-composition.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-if/v-if-composition"},"v-if_v-if-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-if/v-if-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-if/v-if-options"},"v-memo_v-memo-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-memo/v-memo-composition.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-memo/v-memo-composition"},"v-memo_v-memo-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-memo/v-memo-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-memo/v-memo-options"},"v-model_Foo-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-model/Foo-composition.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-model/Foo-composition"},"v-model_v-model-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-model/v-model-composition.uvue","code":"```vue\n\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-model/v-model-composition"},"v-model_v-model-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-model/v-model-options.uvue","code":"```vue\n\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-model/v-model-options"},"v-on_v-on-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-on/v-on-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-on/v-on-composition"},"v-on_v-on-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-on/v-on-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-on/v-on-options"},"v-once_v-once-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-once/v-once-composition.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-once/v-once-composition"},"v-once_v-once-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-once/v-once-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-once/v-once-options"},"v-pre_v-pre":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-pre/v-pre.uvue","code":"```vue\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-pre/v-pre"},"v-show_v-show-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-show/v-show-composition.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-show/v-show-composition"},"v-show_v-show-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-show/v-show-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-show/v-show-options"},"v-slot_Foo-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-slot/Foo-composition.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-slot/Foo-composition"},"v-slot_Foo-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-slot/Foo-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-slot/Foo-options"},"v-slot_v-slot-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-slot/v-slot-composition.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-slot/v-slot-composition"},"v-slot_v-slot-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-slot/v-slot-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-slot/v-slot-options"},"v-text_v-text-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-text/v-text-composition.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-text/v-text-composition"},"v-text_v-text-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/directive/v-text/v-text-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/directive/v-text/v-text-options"}},"E_error":{"runtime-error_runtime-error-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/error/runtime-error/runtime-error-composition.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/error/runtime-error/runtime-error-composition"},"runtime-error_runtime-error-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/error/runtime-error/runtime-error-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/error/runtime-error/runtime-error-options"}},"E_examples":{"nested-component-communication_nested-component-communication-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/examples/nested-component-communication/nested-component-communication-composition.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/examples/nested-component-communication/nested-component-communication-composition"},"nested-component-communication_nested-component-communication-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/examples/nested-component-communication/nested-component-communication-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/examples/nested-component-communication/nested-component-communication-options"},"set-custom-child-component-root-node-class_child":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/examples/set-custom-child-component-root-node-class/child.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/examples/set-custom-child-component-root-node-class/child"},"set-custom-child-component-root-node-class_set-custom-child-component-root-node-class-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/examples/set-custom-child-component-root-node-class/set-custom-child-component-root-node-class-composition.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/examples/set-custom-child-component-root-node-class/set-custom-child-component-root-node-class-composition"},"set-custom-child-component-root-node-class_set-custom-child-component-root-node-class-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/examples/set-custom-child-component-root-node-class/set-custom-child-component-root-node-class-options.uvue","code":"```vue\n\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/examples/set-custom-child-component-root-node-class/set-custom-child-component-root-node-class-options"},"unrecognized-component_unrecognized-component":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/examples/unrecognized-component/unrecognized-component.uvue","code":"```vue\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/examples/unrecognized-component/unrecognized-component"},"nested-component-communication_components_child":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/examples/nested-component-communication/components/child.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/examples/nested-component-communication/components/child"},"nested-component-communication_components_grandChild":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/examples/nested-component-communication/components/grandChild.uvue","code":"```vue\n\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/examples/nested-component-communication/components/grandChild"}},"E_lifecycle":{"component_ChildComponentComposition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/lifecycle/component/ChildComponentComposition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/lifecycle/component/ChildComponentComposition"},"component_ChildComponentOptions":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/lifecycle/component/ChildComponentOptions.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/lifecycle/component/ChildComponentOptions"},"component_component-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/lifecycle/component/component-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/lifecycle/component/component-composition"},"component_component-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/lifecycle/component/component-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/lifecycle/component/component-options"},"page_monitor-page-lifecycle-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/lifecycle/page/monitor-page-lifecycle-composition.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/lifecycle/page/monitor-page-lifecycle-composition"},"page_monitor-page-lifecycle-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/lifecycle/page/monitor-page-lifecycle-options.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/lifecycle/page/monitor-page-lifecycle-options"},"page_page-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/lifecycle/page/page-composition.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/lifecycle/page/page-composition"},"page_page-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/lifecycle/page/page-options.uvue","code":"```vue\n\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/lifecycle/page/page-options"}},"E_render-function":{"cloneVNode_cloneVNode-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/cloneVNode/cloneVNode-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/cloneVNode/cloneVNode-composition"},"cloneVNode_cloneVNode-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/cloneVNode/cloneVNode-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/cloneVNode/cloneVNode-options"},"isVNode_isVNode-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/isVNode/isVNode-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/isVNode/isVNode-composition"},"isVNode_isVNode-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/isVNode/isVNode-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/isVNode/isVNode-options"},"mergeProps_mergeProps-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/mergeProps/mergeProps-composition.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/mergeProps/mergeProps-composition"},"mergeProps_mergeProps-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/mergeProps/mergeProps-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/mergeProps/mergeProps-options"},"render_render-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/render/render-composition.uvue","code":"```vue\n\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/render/render-composition"},"render_render-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/render/render-options.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/render/render-options"},"resolveComponent_resolveComponent-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/resolveComponent/resolveComponent-composition.uvue","code":"```vue\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/resolveComponent/resolveComponent-composition"},"resolveComponent_resolveComponent-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/resolveComponent/resolveComponent-options.uvue","code":"```vue\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/resolveComponent/resolveComponent-options"},"withDirectives_withDirectives-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/withDirectives/withDirectives-composition.uvue","code":"```vue\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/withDirectives/withDirectives-composition"},"withDirectives_withDirectives-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/withDirectives/withDirectives-options.uvue","code":"```vue\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/withDirectives/withDirectives-options"},"withModifiers_withModifiers-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/withModifiers/withModifiers-composition.uvue","code":"```vue\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/withModifiers/withModifiers-composition"},"withModifiers_withModifiers-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/render-function/withModifiers/withModifiers-options.uvue","code":"```vue\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/render-function/withModifiers/withModifiers-options"}},"E_built-in":{"component_keep-alive_keep-alive-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/component/keep-alive/keep-alive-composition.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/component/keep-alive/keep-alive-composition"},"component_keep-alive_keep-alive-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/component/keep-alive/keep-alive-options.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/component/keep-alive/keep-alive-options"},"component_teleport_teleport-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/component/teleport/teleport-composition.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/component/teleport/teleport-composition"},"component_teleport_teleport-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/component/teleport/teleport-options.uvue","code":"```vue\n\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/component/teleport/teleport-options"},"special-elements_component_component-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/component/component-composition.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/component/component-composition"},"special-elements_component_component-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/component/component-options.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/component/component-options"},"special-elements_slots_child-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/slots/child-composition.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/slots/child-composition"},"special-elements_slots_child-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/slots/child-options.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/slots/child-options"},"special-elements_slots_slots-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/slots/slots-composition.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/slots/slots-composition"},"special-elements_slots_slots-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/slots/slots-options.uvue","code":"```vue\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/slots/slots-options"},"special-elements_template_template-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/template/template-composition.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/template/template-composition"},"special-elements_template_template-map-style-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/template/template-map-style-composition.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/template/template-map-style-composition"},"special-elements_template_template-map-style-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/template/template-map-style-options.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/template/template-map-style-options"},"special-elements_template_template-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/built-in/special-elements/template/template-options.uvue","code":"```vue\n\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/built-in/special-elements/template/template-options"}},"E_reactivity":{"advanced_custom-ref_custom-ref":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/custom-ref/custom-ref.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/custom-ref/custom-ref"},"advanced_effect-scope_effect-scope":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/effect-scope/effect-scope.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/effect-scope/effect-scope"},"advanced_get-current-scope_get-current-scope":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/get-current-scope/get-current-scope.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/get-current-scope/get-current-scope"},"advanced_mark-raw_mark-raw":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/mark-raw/mark-raw.uvue","code":"```vue\n \n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/mark-raw/mark-raw"},"advanced_on-scope-dispose_on-scope-dispose":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/on-scope-dispose/on-scope-dispose.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/on-scope-dispose/on-scope-dispose"},"advanced_shallow-reactive_shallow-reactive":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/shallow-reactive/shallow-reactive.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/shallow-reactive/shallow-reactive"},"advanced_shallow-readonly_shallow-readonly":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/shallow-readonly/shallow-readonly.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/shallow-readonly/shallow-readonly"},"advanced_shallow-ref_shallow-ref":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/shallow-ref/shallow-ref.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/shallow-ref/shallow-ref"},"advanced_to-raw_to-raw":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/to-raw/to-raw.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/to-raw/to-raw"},"advanced_trigger-ref_trigger-ref":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/advanced/trigger-ref/trigger-ref.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/advanced/trigger-ref/trigger-ref"},"core_computed_computed-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/computed/computed-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/computed/computed-composition"},"core_computed_computed-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/computed/computed-options.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/computed/computed-options"},"core_reactive_reactive":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/reactive/reactive.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/reactive/reactive"},"core_readonly_readonly":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/readonly/readonly.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/readonly/readonly"},"core_ref_ref":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/ref/ref.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/ref/ref"},"core_watch_watch-composition":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/watch/watch-composition.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/watch/watch-composition"},"core_watch_watch-options":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/watch/watch-options.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/watch/watch-options"},"core_watch-effect_watch-effect":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/watch-effect/watch-effect.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/watch-effect/watch-effect"},"core_watch-post-effect_watch-post-effect":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/watch-post-effect/watch-post-effect.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/watch-post-effect/watch-post-effect"},"core_watch-sync-effect_watch-sync-effect":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/core/watch-sync-effect/watch-sync-effect.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/core/watch-sync-effect/watch-sync-effect"},"utilities_is-proxy_is-proxy":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/utilities/is-proxy/is-proxy.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/utilities/is-proxy/is-proxy"},"utilities_is-reactive_is-reactive":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/utilities/is-reactive/is-reactive.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/utilities/is-reactive/is-reactive"},"utilities_is-readonly_is-readonly":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/utilities/is-readonly/is-readonly.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/utilities/is-readonly/is-readonly"},"utilities_is-ref_is-ref":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/utilities/is-ref/is-ref.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/utilities/is-ref/is-ref"},"utilities_to-ref_to-ref":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/utilities/to-ref/to-ref.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/utilities/to-ref/to-ref"},"utilities_to-refs_to-refs":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/utilities/to-refs/to-refs.uvue","code":"```vue\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/utilities/to-refs/to-refs"},"utilities_to-value_to-value":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/utilities/to-value/to-value.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/utilities/to-value/to-value"},"utilities_un-ref_un-ref":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/pages/reactivity/utilities/un-ref/un-ref.uvue","code":"```vue\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/pages/reactivity/utilities/un-ref/un-ref"}},"E_components":{"Bar":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/Bar.uvue","code":"```vue\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/Bar"},"CompForAppComponent":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/CompForAppComponent.uvue","code":"```vue\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/CompForAppComponent"},"CompForAppUse":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/CompForAppUse.uvue","code":"```vue\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/CompForAppUse"},"CompForHFunction":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/CompForHFunction.uvue","code":"```vue\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/CompForHFunction"},"CompForPlugin":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/CompForPlugin.uvue","code":"```vue\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/CompForPlugin"},"Foo":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/Foo.uvue","code":"```vue\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/Foo"},"define-expose-foo_define-expose-foo":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/define-expose-foo/define-expose-foo.uvue","code":"```vue\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/define-expose-foo/define-expose-foo"},"keep-alive_Counter":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/keep-alive/Counter.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/keep-alive/Counter"},"keep-alive_Message":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/keep-alive/Message.uvue","code":"```vue\n\r\n\r\n\r\n\r\n\r\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/keep-alive/Message"},"keep-alive_ShouldExclude":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/keep-alive/ShouldExclude.uvue","code":"```vue\n\r\n\r\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/keep-alive/ShouldExclude"},"test-type_test-type":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/test-type/test-type.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/test-type/test-type"},"test-type1_test-type1":{"gitUrl":"https://gitcode.net/dcloud/hello-uvue/-/tree/alpha/hello-uvue/components/test-type1/test-type1.uvue","code":"```vue\n\n\n\n\n\n```","webUrl":"https://hellouvue.dcloud.net.cn/#/hello-uvue/components/test-type1/test-type1"}}} \ No newline at end of file diff --git a/docs/plugin/uts-plugin.md b/docs/plugin/uts-plugin.md index b0b5b350d72b6979edbe9e665a0bc0ee4251d0a0..7beb97381361a7c03449028bfac7ee257761120a 100644 --- a/docs/plugin/uts-plugin.md +++ b/docs/plugin/uts-plugin.md @@ -1686,16 +1686,11 @@ utsJsonObj.forEach(function(perField:any){ ## Bug & Tips@tips -### uts插件支持热更新的问题 -> uts插件中的源码编译为原生二进制代码，uts插件自身不支持热更新。 -> 在 uni-app 项目中调用uts插件的源码（如vue页面），打包时编译为js代码，可支持wgt热更新。 -> 在 uni-app x 项目中调用uts插件的源码（如uvue页面），打包时编译为原生二进制代码，不支持热更新。 +### uniapp项目安卓环境 不支持函数重载 -目前已知问题：uni-app 项目中使用uts加密插件（从插件市场购买的uts插件），wgt热更新后无法正常调用uts插件，[ask相关帖子](https://ask.dcloud.net.cn/question/187762) +如果同时存在两个同名函数，仅参数个数/类型不同，在Uni-app 项目 android环境中会无法正确区分两个函数 -此问题仅影响uts加密插件，普通uts插件不影响。 - -HBuilderX4.04版本已解决此问题。 +临时解决办法：以不同的函数名称来区分函数 ## 示例项目 diff --git a/docs/uts/utsactivitycallback.md b/docs/uts/utsactivitycallback.md index 23b195fb858afe5623c2e8dd994c9b487ea8ac22..09c2a60b97bd36d5324b20eda3aee131c1d384aa 100644 --- a/docs/uts/utsactivitycallback.md +++ b/docs/uts/utsactivitycallback.md @@ -4,13 +4,13 @@ 第一类：activity生命周期相关方法[UniActivityLifeCycleCallback](https://doc.dcloud.net.cn/uni-app-x/uts/utsactivitycallback.html#UniActivityLifeCycleCallback)\ 比如 oncreate,ondestory 等\ -第二类: 键盘事件相关方法[UniActivityLifeCycleCallback](https://doc.dcloud.net.cn/uni-app-x/uts/utsactivitycallback.html#UniActivityLifeCycleCallback)\ +第二类: 键盘事件相关方法[UniActivityKeyEventCallback](https://doc.dcloud.net.cn/uni-app-x/uts/utsactivitycallback.html#UniActivityKeyEventCallback)\ 比如 onKeyDown,onKeyUp等\ -第三类:windon窗体的相关方法[UniActivityLifeCycleCallback](https://doc.dcloud.net.cn/uni-app-x/uts/utsactivitycallback.html#UniActivityLifeCycleCallback)\ +第三类:windon窗体的相关方法[UniActivityWindowCallback](https://doc.dcloud.net.cn/uni-app-x/uts/utsactivitycallback.html#UniActivityWindowCallback)\ 比如onCreatePanelMenu，onWindowDismissed等\ -第四类:activity本身自带的相关方法，不继承自其他类[UniActivityLifeCycleCallback](https://doc.dcloud.net.cn/uni-app-x/uts/utsactivitycallback.html#UniActivityLifeCycleCallback)\ +第四类:activity本身自带的相关方法，不继承自其他类[UniActivityCallback](https://doc.dcloud.net.cn/uni-app-x/uts/utsactivitycallback.html#UniActivityCallback)\ 比如onProvideAssistData等\ -第五类：Component 组件相关方法[UniActivityLifeCycleCallback](https://doc.dcloud.net.cn/uni-app-x/uts/utsactivitycallback.html#UniActivityLifeCycleCallback)\ +第五类：Component 组件相关方法[UniActivityComponentCallback](https://doc.dcloud.net.cn/uni-app-x/uts/utsactivitycallback.html#UniActivityComponentCallback)\ 比如onTrimMemory等 并且上面的五个类都为IUniActivityCallback的实现类，我们在使用的时候可以传入具体的实现类，然后按照具体需求重写其中的某个方法，具体用法参考[示例](https://doc.dcloud.net.cn/uni-app-x/uts/utsactivitycallback.html#示例)