Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
80252784
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
80252784
编写于
7月 06, 2022
作者:
T
tianyu
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
explain
Signed-off-by:
N
tianyu
<
tianyu55@h-partners.com
>
上级
409b01e3
变更
76
隐藏空白更改
内联
并排
Showing
76 changed file
with
856 addition
and
755 deletion
+856
-755
zh-cn/application-dev/reference/apis/js-apis-animator.md
zh-cn/application-dev/reference/apis/js-apis-animator.md
+14
-12
zh-cn/application-dev/reference/apis/js-apis-bytrace.md
zh-cn/application-dev/reference/apis/js-apis-bytrace.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-connectedTag.md
zh-cn/application-dev/reference/apis/js-apis-connectedTag.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-contact.md
zh-cn/application-dev/reference/apis/js-apis-contact.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-continuation-continuationExtraParams.md
...ence/apis/js-apis-continuation-continuationExtraParams.md
+3
-1
zh-cn/application-dev/reference/apis/js-apis-convertxml.md
zh-cn/application-dev/reference/apis/js-apis-convertxml.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-fileio.md
zh-cn/application-dev/reference/apis/js-apis-fileio.md
+394
-394
zh-cn/application-dev/reference/apis/js-apis-i18n.md
zh-cn/application-dev/reference/apis/js-apis-i18n.md
+3
-0
zh-cn/application-dev/reference/apis/js-apis-image.md
zh-cn/application-dev/reference/apis/js-apis-image.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
+19
-17
zh-cn/application-dev/reference/apis/js-apis-intl.md
zh-cn/application-dev/reference/apis/js-apis-intl.md
+3
-0
zh-cn/application-dev/reference/apis/js-apis-logs.md
zh-cn/application-dev/reference/apis/js-apis-logs.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-mediaquery.md
zh-cn/application-dev/reference/apis/js-apis-mediaquery.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-prompt.md
zh-cn/application-dev/reference/apis/js-apis-prompt.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-router.md
zh-cn/application-dev/reference/apis/js-apis-router.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-system-mediaquery.md
...plication-dev/reference/apis/js-apis-system-mediaquery.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-system-prompt.md
...n/application-dev/reference/apis/js-apis-system-prompt.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-system-router.md
...n/application-dev/reference/apis/js-apis-system-router.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md
...tion-dev/reference/arkui-ts/ts-basic-components-button.md
+9
-10
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md
...reference/arkui-ts/ts-basic-components-loadingprogress.md
+2
-2
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md
...tion-dev/reference/arkui-ts/ts-basic-components-qrcode.md
+6
-7
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-rating.md
...tion-dev/reference/arkui-ts/ts-basic-components-rating.md
+11
-12
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md
...cation-dev/reference/arkui-ts/ts-basic-components-span.md
+4
-5
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md
...ion-dev/reference/arkui-ts/ts-basic-components-stepper.md
+8
-9
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepperitem.md
...dev/reference/arkui-ts/ts-basic-components-stepperitem.md
+7
-8
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md
...cation-dev/reference/arkui-ts/ts-basic-components-text.md
+17
-18
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md
...on-dev/reference/arkui-ts/ts-basic-components-textarea.md
+2
-3
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md
...n-dev/reference/arkui-ts/ts-basic-components-textinput.md
+2
-3
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md
...-dev/reference/arkui-ts/ts-basic-components-textpicker.md
+9
-10
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md
...n-dev/reference/arkui-ts/ts-basic-components-texttimer.md
+10
-11
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-timepicker.md
...-dev/reference/arkui-ts/ts-basic-components-timepicker.md
+11
-12
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md
...tion-dev/reference/arkui-ts/ts-basic-components-toggle.md
+3
-1
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md
.../reference/arkui-ts/ts-basic-gestures-longpressgesture.md
+13
-11
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md
...on-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md
+24
-22
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md
...-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md
+15
-13
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md
...v/reference/arkui-ts/ts-basic-gestures-rotationgesture.md
+12
-10
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md
...-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md
+11
-9
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md
...on-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md
+8
-6
zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md
...pplication-dev/reference/arkui-ts/ts-combined-gestures.md
+8
-6
zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-lottie.md
...ion-dev/reference/arkui-ts/ts-components-canvas-lottie.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md
...n-dev/reference/arkui-ts/ts-container-alphabet-indexer.md
+19
-22
zh-cn/application-dev/reference/arkui-ts/ts-container-badge.md
.../application-dev/reference/arkui-ts/ts-container-badge.md
+6
-7
zh-cn/application-dev/reference/arkui-ts/ts-container-flex.md
...n/application-dev/reference/arkui-ts/ts-container-flex.md
+2
-3
zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md
...pplication-dev/reference/arkui-ts/ts-container-refresh.md
+2
-2
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-circle.md
...on-dev/reference/arkui-ts/ts-drawing-components-circle.md
+8
-9
zh-cn/application-dev/reference/arkui-ts/ts-explicit-animation.md
...plication-dev/reference/arkui-ts/ts-explicit-animation.md
+11
-9
zh-cn/application-dev/reference/arkui-ts/ts-gesture-settings.md
...application-dev/reference/arkui-ts/ts-gesture-settings.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-interpolation-calculation.md
...on-dev/reference/arkui-ts/ts-interpolation-calculation.md
+37
-35
zh-cn/application-dev/reference/arkui-ts/ts-matrix-transformation.md
...cation-dev/reference/arkui-ts/ts-matrix-transformation.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md
...ation-dev/reference/arkui-ts/ts-media-components-video.md
+2
-2
zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md
zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click.md
...n-dev/reference/arkui-ts/ts-universal-attributes-click.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-component-id.md
...eference/arkui-ts/ts-universal-attributes-component-id.md
+12
-12
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-enable.md
...-dev/reference/arkui-ts/ts-universal-attributes-enable.md
+4
-2
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md
...n-dev/reference/arkui-ts/ts-universal-attributes-focus.md
+4
-2
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-gradient-color.md
...erence/arkui-ts/ts-universal-attributes-gradient-color.md
+12
-10
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-hover-effect.md
...eference/arkui-ts/ts-universal-attributes-hover-effect.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-image-effect.md
...eference/arkui-ts/ts-universal-attributes-image-effect.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-layout-constraints.md
...ce/arkui-ts/ts-universal-attributes-layout-constraints.md
+5
-3
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-location.md
...ev/reference/arkui-ts/ts-universal-attributes-location.md
+6
-4
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md
...on-dev/reference/arkui-ts/ts-universal-attributes-menu.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-overlay.md
...dev/reference/arkui-ts/ts-universal-attributes-overlay.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md
...n-dev/reference/arkui-ts/ts-universal-attributes-popup.md
+8
-6
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-sharp-clipping.md
...erence/arkui-ts/ts-universal-attributes-sharp-clipping.md
+5
-3
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md
...on-dev/reference/arkui-ts/ts-universal-attributes-size.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-transformation.md
...erence/arkui-ts/ts-universal-attributes-transformation.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md
.../reference/arkui-ts/ts-universal-attributes-visibility.md
+6
-4
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-z-order.md
...dev/reference/arkui-ts/ts-universal-attributes-z-order.md
+4
-2
zh-cn/application-dev/reference/arkui-ts/ts-universal-component-area-change-event.md
...ence/arkui-ts/ts-universal-component-area-change-event.md
+5
-3
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md
...ation-dev/reference/arkui-ts/ts-universal-events-click.md
+9
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md
...n-dev/reference/arkui-ts/ts-universal-events-drag-drop.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md
...ication-dev/reference/arkui-ts/ts-universal-events-key.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-show-hide.md
...n-dev/reference/arkui-ts/ts-universal-events-show-hide.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md
...ation-dev/reference/arkui-ts/ts-universal-events-touch.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-focus-event.md
...cation-dev/reference/arkui-ts/ts-universal-focus-event.md
+5
-3
zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md
...lication-dev/reference/arkui-ts/ts-universal-mouse-key.md
+2
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-animator.md
浏览文件 @
80252784
# 动画
本模块提供组件动画效果,包括定义动画、启动动画和以相反的顺序播放动画等。
> **说明:**
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
@@ -21,14 +23,14 @@ createAnimator(options: AnimatorOptions): AnimatorResult
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| options |
[
AnimatorOptions
](
#animatoroptions
)
| 是 | 定义动画选项。|
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| options |
[
AnimatorOptions
](
#animatoroptions
)
| 是 | 定义动画选项。|
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
AnimatorResult
](
#animatorresult
)
| Animator结果接口。 |
| 类型 | 说明 |
| -------- | -------- |
|
[
AnimatorResult
](
#animatorresult
)
| Animator结果接口。 |
**示例:**
...
...
@@ -92,9 +94,9 @@ update(options: AnimatorOptions): void
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| options |
[
AnimatorOptions
](
#animatoroptions
)
| 是 | 定义动画选项。|
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| options |
[
AnimatorOptions
](
#animatoroptions
)
| 是 | 定义动画选项。|
**示例:**
```
...
...
@@ -175,9 +177,9 @@ onframe: (progress: number) => void
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| progress | number | 是 | 动画的当前进度。|
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| progress | number | 是 | 动画的当前进度。|
**示例:**
```
...
...
zh-cn/application-dev/reference/apis/js-apis-bytrace.md
浏览文件 @
80252784
# 性能打点
本模块提供了追踪进程轨迹。
> **说明:**
> - 从API Version 8开始,该接口不再维护,推荐使用新接口[`@ohos.hiTraceMeter`](js-apis-hitracemeter.md)。
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-connectedTag.md
浏览文件 @
80252784
# 有源标签
本模块提供有源标签的使用,包括初始化有源标签芯片、读取有源标签内容、写入内容到有源标签等。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-contact.md
浏览文件 @
80252784
# 联系人
本模块提供联系人管理能力,包括添加联系人、删除联系人、更新联系人等
>**说明:**
>
>本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-continuation-continuationExtraParams.md
浏览文件 @
80252784
# ContinuationExtraParams
本模块提供流转管理入口中互联面板所需的过滤参数。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
@@ -15,7 +17,7 @@ import continuationManager from "@ohos.continuation.continuationManager"
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.DistributedAbilityManager
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| deviceType | Array
\<
string> | 是 | 是 | 表示设备类型。|
| targetBundle | string | 是 | 是 | 表示目标包名。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-convertxml.md
浏览文件 @
80252784
# xml转换JavaScript
本模块提供转换xml文本为JavaScript对象的选项。
> **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-fileio.md
浏览文件 @
80252784
文件管理
#
文件管理
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
@@ -41,9 +41,9 @@ stat(path: string): Promise<Stat>
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ---------- |
| Promise
<
[Stat](#stat)
>
| Promise对象。返回文件的具体信息。 |
| 类型 | 说明 |
| ---------------------------- | ---------- |
| Promise
<
[Stat](#stat)
>
| Promise对象。返回文件的具体信息。 |
**示例:**
```
js
...
...
@@ -92,9 +92,9 @@ statSync(path:string): Stat
**返回值:**
| 类型 | 说明 |
| ------------- | ---------- |
|
[
Stat
](
#stat
)
| 表示文件的具体信息。 |
| 类型 | 说明 |
| ------------- | ---------- |
|
[
Stat
](
#stat
)
| 表示文件的具体信息。 |
**示例:**
```
js
...
...
@@ -117,9 +117,9 @@ opendir(path: string): Promise<Dir>
| path | string | 是 | 待打开文件目录的应用沙箱路径。 |
**返回值:**
| 类型 | 说明 |
| -------------------------- | -------- |
| Promise
<
[Dir](#dir)
>
| Promise对象。返回Dir对象。 |
| 类型 | 说明 |
| -------------------------- | -------- |
| Promise
<
[Dir](#dir)
>
| Promise对象。返回Dir对象。 |
**示例:**
```
js
...
...
@@ -171,9 +171,9 @@ opendirSync(path: string): Dir
| path | string | 是 | 待打开文件目录的应用沙箱路径。 |
**返回值:**
| 类型 | 说明 |
| ----------- | -------- |
|
[
Dir
](
#dir
)
| 返回Dir对象。 |
| 类型 | 说明 |
| ----------- | -------- |
|
[
Dir
](
#dir
)
| 返回Dir对象。 |
**示例:**
```
js
...
...
@@ -199,9 +199,9 @@ access(path: string, mode?: number): Promise<void>
| mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。
<br/>
确认当前进程是否具有对应权限:
<br/>
-
0:确认文件是否存在。
<br/>
-
1:确认当前进程是否具有可执行权限。
<br/>
-
2:确认当前进程是否具有写权限。
<br/>
-
4:确认当前进程是否具有读权限。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -269,14 +269,14 @@ close(fd: number):Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待关闭文件的文件描述符。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待关闭文件的文件描述符。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -298,10 +298,10 @@ close(fd: number, callback:AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------ |
| fd | number | 是 | 待关闭文件的文件描述符。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件之后的回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------ |
| fd | number | 是 | 待关闭文件的文件描述符。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件之后的回调。 |
**示例:**
```
js
...
...
@@ -321,9 +321,9 @@ closeSync(fd: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待关闭文件的文件描述符。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待关闭文件的文件描述符。 |
**示例:**
```
js
...
...
@@ -340,9 +340,9 @@ close(): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -363,9 +363,9 @@ close(callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------- |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件流之后的回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------- |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件流之后的回调。 |
**示例:**
```
js
...
...
@@ -384,16 +384,16 @@ copyFile(src:string | number, dest:string | number, mode?:number):Promise<voi
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | -------------------------- | ---- | ---------------------------------------- |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | -------------------------- | ---- | ---------------------------------------- |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -414,12 +414,12 @@ copyFile(src: string | number, dest: string | number, mode: number, callback: As
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ---------------------------------------- |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步复制文件之后的回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ---------------------------------------- |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步复制文件之后的回调。 |
**示例:**
```
js
...
...
@@ -438,11 +438,11 @@ copyFileSync(src: string | number, dest: string | number, mode?: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | -------------------------- | ---- | ---------------------------------------- |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | -------------------------- | ---- | ---------------------------------------- |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
**示例:**
```
js
...
...
@@ -465,9 +465,9 @@ mkdir(path:string, mode?: number): Promise<void>
| mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。
<br/>
-
0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -538,9 +538,9 @@ open(path: string, flags?: number, mode?: number): Promise<number>
| mode | number | 否 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。
<br/>
-
0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ----------- |
| Promise
<
number
>
| Promise对象。返回打开文件的文件描述符。 |
| 类型 | 说明 |
| --------------------- | ----------- |
| Promise
<
number
>
| Promise对象。返回打开文件的文件描述符。 |
**示例:**
```
js
...
...
@@ -592,9 +592,9 @@ openSync(path:string, flags?:number, mode?:number): number
| mode | number | 否 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。
<br/>
-
0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。
<br/>
-
0o640:所有者具有读、写权限,所有用户组具有读权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。
<br/>
创建出的文件权限受umask影响,umask随进程启动确定,其修改当前不开放。 |
**返回值:**
| 类型 | 说明 |
| ------ | ----------- |
| number | 打开文件的文件描述符。 |
| 类型 | 说明 |
| ------ | ----------- |
| number | 打开文件的文件描述符。 |
**示例:**
```
js
...
...
@@ -631,9 +631,9 @@ read(fd: number, buffer: ArrayBuffer, options?: {
**返回值:**
| 类型 | 说明 |
| ---------------------------------- | ------ |
| Promise
<
[ReadOut](#readout)
>
| Promise对象。返回读取的结果。 |
| 类型 | 说明 |
| ---------------------------------- | ------ |
| Promise
<
[ReadOut](#readout)
>
| Promise对象。返回读取的结果。 |
**示例:**
```
js
...
...
@@ -661,12 +661,12 @@ read(fd: number, buffer: ArrayBuffer, options: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待读取文件的文件描述符。 |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是 | 异步读取数据之后的回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待读取文件的文件描述符。 |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是 | 异步读取数据之后的回调。 |
**示例:**
```
js
...
...
@@ -694,16 +694,16 @@ readSync(fd: number, buffer: ArrayBuffer, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待读取文件的文件描述符。 |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待读取文件的文件描述符。 |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
**返回值:**
| 类型 | 说明 |
| ------ | -------- |
| number | 实际读取的长度。 |
| 类型 | 说明 |
| ------ | -------- |
| number | 实际读取的长度。 |
**示例:**
```
js
...
...
@@ -727,9 +727,9 @@ rmdir(path: string): Promise<void>
| path | string | 是 | 待删除目录的应用沙箱路径。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -797,9 +797,9 @@ unlink(path:string): Promise<void>
| path | string | 是 | 待删除文件的应用沙箱路径。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -866,16 +866,16 @@ write(fd: number, buffer: ArrayBuffer | string, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待写入文件的文件描述符。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待写入文件的文件描述符。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
**返回值:**
| 类型 | 说明 |
| --------------------- | -------- |
| Promise
<
number
>
| Promise对象。返回实际写入的长度。 |
| 类型 | 说明 |
| --------------------- | -------- |
| Promise
<
number
>
| Promise对象。返回实际写入的长度。 |
**示例:**
```
js
...
...
@@ -902,12 +902,12 @@ write(fd: number, buffer: ArrayBuffer | string, options: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待写入文件的文件描述符。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
| callback | AsyncCallback
<
number
>
| 是 | 异步将数据写入完成后执行的回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待写入文件的文件描述符。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
| callback | AsyncCallback
<
number
>
| 是 | 异步将数据写入完成后执行的回调函数。 |
**示例:**
```
js
...
...
@@ -934,16 +934,16 @@ writeSync(fd: number, buffer: ArrayBuffer | string, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待写入文件的文件描述符。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待写入文件的文件描述符。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
**返回值:**
| 类型 | 说明 |
| ------ | -------- |
| number | 实际写入的长度。 |
| 类型 | 说明 |
| ------ | -------- |
| number | 实际写入的长度。 |
**示例:**
```
js
...
...
@@ -967,9 +967,9 @@ hash(path: string, algorithm: string): Promise<string>
| algorithm | string | 是 | 哈希计算采用的算法。可选
"md5"、"sha1"
或
"sha256"。建议采用安全强度更高的
"sha256"。 |
**返回值:**
| 类型 | 说明 |
| --------------------- | -------------------------- |
| Promise
<
string
>
| Promise对象。返回文件的哈希值。表示为十六进制数字串,所有字母均大写。 |
| 类型 | 说明 |
| --------------------- | -------------------------- |
| Promise
<
string
>
| Promise对象。返回文件的哈希值。表示为十六进制数字串,所有字母均大写。 |
**示例:**
```
js
...
...
@@ -1021,9 +1021,9 @@ chmod(path: string, mode: number):Promise<void>
| mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -1087,14 +1087,14 @@ fstat(fd: number): Promise<Stat>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待获取文件状态的文件描述符。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待获取文件状态的文件描述符。 |
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ---------- |
| Promise
<
[Stat](#stat)
>
| Promise对象。返回表示文件状态的具体信息。 |
| 类型 | 说明 |
| ---------------------------- | ---------- |
| Promise
<
[Stat](#stat)
>
| Promise对象。返回表示文件状态的具体信息。 |
**示例:**
```
js
...
...
@@ -1115,10 +1115,10 @@ fstat(fd: number, callback: AsyncCallback<Stat>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | ---------------- |
| fd | number | 是 | 待获取文件状态的文件描述符。 |
| callback | AsyncCallback
<
[Stat](#stat)
>
| 是 | 异步获取文件状态信息之后的回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | ---------------- |
| fd | number | 是 | 待获取文件状态的文件描述符。 |
| callback | AsyncCallback
<
[Stat](#stat)
>
| 是 | 异步获取文件状态信息之后的回调。 |
**示例:**
```
js
...
...
@@ -1138,14 +1138,14 @@ fstatSync(fd: number): Stat
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待获取文件状态的文件描述符。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待获取文件状态的文件描述符。 |
**返回值:**
| 类型 | 说明 |
| ------------- | ---------- |
|
[
Stat
](
#stat
)
| 表示文件状态的具体信息。 |
| 类型 | 说明 |
| ------------- | ---------- |
|
[
Stat
](
#stat
)
| 表示文件状态的具体信息。 |
**示例:**
```
js
...
...
@@ -1163,15 +1163,15 @@ ftruncate(fd: number, len?: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 否 | 文件截断后的长度,以字节为单位。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 否 | 文件截断后的长度,以字节为单位。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。|
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。|
**示例:**
```
js
...
...
@@ -1193,11 +1193,11 @@ ftruncate(fd: number, len: number, callback:AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 是 | 文件截断后的长度,以字节为单位。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,本调用无返回值。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 是 | 文件截断后的长度,以字节为单位。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,本调用无返回值。 |
**示例:**
```
js
...
...
@@ -1216,10 +1216,10 @@ ftruncateSync(fd: number, len?: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 否 | 文件截断后的长度,以字节为单位。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 否 | 文件截断后的长度,以字节为单位。 |
**示例:**
```
js
...
...
@@ -1242,9 +1242,9 @@ truncate(path: string, len?: number): Promise<void>
| len | number | 否 | 文件截断后的长度,以字节为单位。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -1318,9 +1318,9 @@ readText(filePath: string, options?: {
| options | Object | 否 | 支持如下选项:
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
encoding,string类型,当数据是
string
类型时有效,表示数据的编码方式,默认
'utf-8',仅支持
'utf-8'。 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ---------- |
| Promise
<
string
>
| Promise对象。返回读取文件的内容。 |
| 类型 | 说明 |
| --------------------- | ---------- |
| Promise
<
string
>
| Promise对象。返回读取文件的内容。 |
**示例:**
```
js
...
...
@@ -1378,9 +1378,9 @@ readTextSync(filePath: string, options?: {
| options | Object | 否 | 支持如下选项:
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
encoding,string类型,当数据是
string
类型时有效,表示数据的编码方式,默认
'utf-8',仅支持
'utf-8'。 |
**返回值:**
| 类型 | 说明 |
| ------ | -------------------- |
| string | 返回读取文件的内容。 |
| 类型 | 说明 |
| ------ | -------------------- |
| string | 返回读取文件的内容。 |
**示例:**
```
js
...
...
@@ -1402,9 +1402,9 @@ lstat(path: string): Promise<Stat>
| path | string | 是 | 目标文件的应用沙箱路径。 |
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ---------- |
| Promise
<
[Stat](#stat)
>
| promise对象,返回文件对象,表示文件的具体信息,详情见stat。 |
| 类型 | 说明 |
| ---------------------------- | ---------- |
| Promise
<
[Stat](#stat)
>
| promise对象,返回文件对象,表示文件的具体信息,详情见stat。 |
**示例:**
```
js
...
...
@@ -1452,9 +1452,9 @@ lstatSync(path:string): Stat
| path | string | 是 | 目标文件的应用沙箱路径。 |
**返回值:**
| 类型 | 说明 |
| ------------- | ---------- |
|
[
Stat
](
#stat
)
| 表示文件的具体信息。 |
| 类型 | 说明 |
| ------------- | ---------- |
|
[
Stat
](
#stat
)
| 表示文件的具体信息。 |
**示例:**
```
js
...
...
@@ -1475,15 +1475,15 @@ read(buffer: ArrayBuffer, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ------------------------------------------------------------ |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
约束:offset+length<=buffer.size。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ------------------------------------------------------------ |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
约束:offset+length<=buffer.size。 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------- | ------ |
| Promise
<
[ReadOut](#readout)
>
| Promise对象。返回读取的结果。 |
| 类型 | 说明 |
| ---------------------------------- | ------ |
| Promise
<
[ReadOut](#readout)
>
| Promise对象。返回读取的结果。 |
**示例:**
```
js
...
...
@@ -1509,11 +1509,11 @@ read(buffer: ArrayBuffer, options: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
约束:offset+length<=buffer.size。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是 | 异步从文件读取数据之后的回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
约束:offset+length<=buffer.size。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是 | 异步从文件读取数据之后的回调。 |
**示例:**
```
js
...
...
@@ -1542,9 +1542,9 @@ rename(oldPath: string, newPath: string): Promise<void>
| newPath | String | 是 | 目标文件的新应用沙箱路径。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -1607,14 +1607,14 @@ fsync(fd: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -1635,10 +1635,10 @@ fsync(fd: number, callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | --------------- |
| fd | number | 是 | 待同步文件的文件描述符。 |
| Callback | AsyncCallback
<
void
>
| 是 | 异步将文件数据同步之后的回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | --------------- |
| fd | number | 是 | 待同步文件的文件描述符。 |
| Callback | AsyncCallback
<
void
>
| 是 | 异步将文件数据同步之后的回调。 |
**示例:**
```
js
...
...
@@ -1657,9 +1657,9 @@ fsyncSync(fd: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 |
**示例:**
```
js
...
...
@@ -1676,14 +1676,14 @@ fdatasync(fd: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -1704,10 +1704,10 @@ fdatasync(fd: number, callback:AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ----------------- |
| fd | number | 是 | 待同步文件的文件描述符。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步将文件内容数据同步之后的回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ----------------- |
| fd | number | 是 | 待同步文件的文件描述符。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步将文件内容数据同步之后的回调。 |
**示例:**
```
js
...
...
@@ -1726,9 +1726,9 @@ fdatasyncSync(fd: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 |
**示例:**
```
js
...
...
@@ -1751,9 +1751,9 @@ symlink(target: string, srcPath: string): Promise<void>
| srcPath | string | 是 | 符号链接文件的应用沙箱路径。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -1824,9 +1824,9 @@ chown(path: string, uid: number, gid: number): Promise<void>
| gid | number | 是 | 新的GID(GroupID)。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -1895,14 +1895,14 @@ mkdtemp(prefix: string): Promise<string>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | --------------------------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | --------------------------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ---------- |
| Promise
<
string
>
| Promise对象。返回生成的唯一目录路径。 |
| 类型 | 说明 |
| --------------------- | ---------- |
| Promise
<
string
>
| Promise对象。返回生成的唯一目录路径。 |
**示例:**
```
js
...
...
@@ -1923,10 +1923,10 @@ mkdtemp(prefix: string, callback: AsyncCallback<string>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------------------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
| callback | AsyncCallback
<
string
>
| 是 | 异步创建临时目录之后的回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------------------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
| callback | AsyncCallback
<
string
>
| 是 | 异步创建临时目录之后的回调。 |
**示例:**
```
js
...
...
@@ -1945,14 +1945,14 @@ mkdtempSync(prefix: string): string
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | --------------------------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | --------------------------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
**返回值:**
| 类型 | 说明 |
| ------ | ---------- |
| string | 产生的唯一目录路径。 |
| 类型 | 说明 |
| ------ | ---------- |
| string | 产生的唯一目录路径。 |
**示例:**
```
js
...
...
@@ -1969,15 +1969,15 @@ fchmod(fd: number, mode: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待改变文件的文件描述符。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待改变文件的文件描述符。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -1998,11 +1998,11 @@ fchmod(fd: number, mode: number, callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待改变文件的文件描述符。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件权限之后的回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待改变文件的文件描述符。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件权限之后的回调。 |
**示例:**
```
js
...
...
@@ -2021,10 +2021,10 @@ fchmodSync(fd: number, mode: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待改变文件的文件描述符。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待改变文件的文件描述符。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
**示例:**
```
js
...
...
@@ -2047,9 +2047,9 @@ createStream(path: string, mode: string): Promise<Stream>
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
**返回值:**
| 类型 | 说明 |
| --------------------------------- | --------- |
| Promise
<
[Stream](#stream7)
>
| Promise对象。返回文件流的结果。 |
| 类型 | 说明 |
| --------------------------------- | --------- |
| Promise
<
[Stream](#stream7)
>
| Promise对象。返回文件流的结果。 |
**示例:**
```
js
...
...
@@ -2099,9 +2099,9 @@ createStreamSync(path: string, mode: string): Stream
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
**返回值:**
| 类型 | 说明 |
| ------------------ | --------- |
|
[
Stream
](
#stream7
)
| 返回文件流的结果。 |
| 类型 | 说明 |
| ------------------ | --------- |
|
[
Stream
](
#stream7
)
| 返回文件流的结果。 |
**示例:**
```
js
...
...
@@ -2118,15 +2118,15 @@ fdopenStream(fd: number, mode: string): Promise<Stream>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待打开文件的文件描述符。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待打开文件的文件描述符。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
**返回值:**
| 类型 | 说明 |
| --------------------------------- | --------- |
| Promise
<
[Stream](#stream7)
>
| Promise对象。返回文件流的结果。 |
| 类型 | 说明 |
| --------------------------------- | --------- |
| Promise
<
[Stream](#stream7)
>
| Promise对象。返回文件流的结果。 |
**示例:**
```
js
...
...
@@ -2148,11 +2148,11 @@ fdopenStream(fd: number, mode: string, callback: AsyncCallback<Stream>): v
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待打开文件的文件描述符。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
| callback | AsyncCallback
<
[Stream](#stream7)
>
| 是 | 异步打开文件流之后的回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待打开文件的文件描述符。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
| callback | AsyncCallback
<
[Stream](#stream7)
>
| 是 | 异步打开文件流之后的回调。 |
**示例:**
```
js
...
...
@@ -2172,15 +2172,15 @@ fdopenStreamSync(fd: number, mode: string): Stream
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待打开文件的文件描述符。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待打开文件的文件描述符。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
**返回值:**
| 类型 | 说明 |
| ------------------ | --------- |
|
[
Stream
](
#stream7
)
| 返回文件流的结果。 |
| 类型 | 说明 |
| ------------------ | --------- |
|
[
Stream
](
#stream7
)
| 返回文件流的结果。 |
**示例:**
```
js
...
...
@@ -2198,16 +2198,16 @@ fchown(fd: number, uid: number, gid: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待改变文件的文件描述符。 |
| uid | number | 是 | 文件所有者的UID。 |
| gid | number | 是 | 文件所有组的GID。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待改变文件的文件描述符。 |
| uid | number | 是 | 文件所有者的UID。 |
| gid | number | 是 | 文件所有组的GID。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -2229,12 +2229,12 @@ fchown(fd: number, uid: number, gid: number, callback: AsyncCallback<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | --------------- |
| fd | number | 是 | 待改变文件的文件描述符。 |
| uid | number | 是 | 文件所有者的UID。 |
| gid | number | 是 | 文件所有组的GID。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件所有者之后的回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | --------------- |
| fd | number | 是 | 待改变文件的文件描述符。 |
| uid | number | 是 | 文件所有者的UID。 |
| gid | number | 是 | 文件所有组的GID。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件所有者之后的回调。 |
**示例:**
```
js
...
...
@@ -2254,11 +2254,11 @@ fchownSync(fd: number, uid: number, gid: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待改变文件的文件描述符。 |
| uid | number | 是 | 文件所有者的UID。 |
| gid | number | 是 | 文件所有组的GID。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待改变文件的文件描述符。 |
| uid | number | 是 | 文件所有者的UID。 |
| gid | number | 是 | 文件所有组的GID。 |
**示例:**
```
js
...
...
@@ -2283,9 +2283,9 @@ lchown(path: string, uid: number, gid: number): Promise<void>
| gid | number | 是 | 新的GID。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
```
js
...
...
@@ -2361,9 +2361,9 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe
| callback | AsyncCallback
<
number
>
| 是 | 每发生变化一次,调用一次此函数。 |
**返回值:**
| 类型 | 说明 |
| -------------------- | ---------- |
|
[
Watcher
](
#watcher7
)
| Promise对象。返回文件变化监听的实例。 |
| 类型 | 说明 |
| -------------------- | ---------- |
|
[
Watcher
](
#watcher7
)
| Promise对象。返回文件变化监听的实例。 |
**示例:**
```
js
...
...
@@ -2421,9 +2421,9 @@ isBlockDevice(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------- | ---------------- |
| boolean | 表示文件是否是块特殊设备。 |
| 类型 | 说明 |
| ------- | ---------------- |
| boolean | 表示文件是否是块特殊设备。 |
**示例:**
```
js
...
...
@@ -2440,9 +2440,9 @@ isCharacterDevice(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------- | ----------------- |
| boolean | 表示文件是否是字符特殊设备。 |
| 类型 | 说明 |
| ------- | ----------------- |
| boolean | 表示文件是否是字符特殊设备。 |
**示例:**
```
js
...
...
@@ -2459,9 +2459,9 @@ isDirectory(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------- | ------------- |
| boolean | 表示文件是否是目录。 |
| 类型 | 说明 |
| ------- | ------------- |
| boolean | 表示文件是否是目录。 |
**示例:**
```
js
...
...
@@ -2478,9 +2478,9 @@ isFIFO(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------- | --------------------- |
| boolean | 表示文件是否是
FIFO。 |
| 类型 | 说明 |
| ------- | --------------------- |
| boolean | 表示文件是否是
FIFO。 |
**示例:**
```
js
...
...
@@ -2497,9 +2497,9 @@ isFile(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------- | --------------- |
| boolean | 表示文件是否是普通文件。 |
| 类型 | 说明 |
| ------- | --------------- |
| boolean | 表示文件是否是普通文件。 |
**示例:**
```
js
...
...
@@ -2516,9 +2516,9 @@ isSocket(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------- | -------------- |
| boolean | 表示文件是否是套接字。 |
| 类型 | 说明 |
| ------- | -------------- |
| boolean | 表示文件是否是套接字。 |
**示例:**
```
js
...
...
@@ -2535,9 +2535,9 @@ isSymbolicLink(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------- | --------------- |
| boolean | 表示文件是否是符号链接。 |
| 类型 | 说明 |
| ------- | --------------- |
| boolean | 表示文件是否是符号链接。 |
**示例:**
```
js
...
...
@@ -2579,9 +2579,9 @@ stop(callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------- |
| callback | AsyncCallback
<
void
>
| 是 | 以异步方法关闭watcher监听之后的回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------- |
| callback | AsyncCallback
<
void
>
| 是 | 以异步方法关闭watcher监听之后的回调。 |
**示例:**
```
js
...
...
@@ -2609,9 +2609,9 @@ close(): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------- |
| Promise
<
void
>
| Promise对象。返回表示异步关闭文件流的结果。 |
| 类型 | 说明 |
| ------------------- | ------------- |
| Promise
<
void
>
| Promise对象。返回表示异步关闭文件流的结果。 |
**示例:**
```
js
...
...
@@ -2633,9 +2633,9 @@ close(callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------- |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件流之后的回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------- |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件流之后的回调。 |
**示例:**
```
js
...
...
@@ -2670,9 +2670,9 @@ flush(): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------- |
| Promise
<
void
>
| Promise对象。返回表示异步刷新文件流的结果。 |
| 类型 | 说明 |
| ------------------- | ------------- |
| Promise
<
void
>
| Promise对象。返回表示异步刷新文件流的结果。 |
**示例:**
```
js
...
...
@@ -2694,9 +2694,9 @@ flush(callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------- |
| callback | AsyncCallback
<
void
>
| 是 | 异步刷新文件流后的回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------- |
| callback | AsyncCallback
<
void
>
| 是 | 异步刷新文件流后的回调函数。 |
**示例:**
```
js
...
...
@@ -2736,15 +2736,15 @@ write(buffer: ArrayBuffer | string, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
**返回值:**
| 类型 | 说明 |
| --------------------- | -------- |
| Promise
<
number
>
| Promise对象。返回实际写入的长度。 |
| 类型 | 说明 |
| --------------------- | -------- |
| Promise
<
number
>
| Promise对象。返回实际写入的长度。 |
**示例:**
```
js
...
...
@@ -2771,11 +2771,11 @@ write(buffer: ArrayBuffer | string, options: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
| callback | AsyncCallback
<
number
>
| 是 | 异步写入完成后执行的回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
| callback | AsyncCallback
<
number
>
| 是 | 异步写入完成后执行的回调函数。 |
**示例:**
```
js
...
...
@@ -2803,15 +2803,15 @@ writeSync(buffer: ArrayBuffer | string, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
**返回值:**
| 类型 | 说明 |
| ------ | -------- |
| number | 实际写入的长度。 |
| 类型 | 说明 |
| ------ | -------- |
| number | 实际写入的长度。 |
**示例:**
```
js
...
...
@@ -2833,15 +2833,15 @@ read(buffer: ArrayBuffer, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------- | ------ |
| Promise
<
[ReadOut](#readout)
>
| Promise对象。返回读取的结果。 |
| 类型 | 说明 |
| ---------------------------------- | ------ |
| Promise
<
[ReadOut](#readout)
>
| Promise对象。返回读取的结果。 |
**示例:**
```
js
...
...
@@ -2868,11 +2868,11 @@ read(buffer: ArrayBuffer, options: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是 | 异步从流文件读取数据之后的回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是 | 异步从流文件读取数据之后的回调。 |
**示例:**
```
js
...
...
@@ -2900,16 +2900,16 @@ readSync(buffer: ArrayBuffer, options?: {
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
**返回值:**
| 类型 | 说明 |
| ------ | -------- |
| number | 实际读取的长度。 |
| 类型 | 说明 |
| ------ | -------- |
| number | 实际读取的长度。 |
**示例:**
```
js
...
...
@@ -2932,9 +2932,9 @@ read(): Promise<Dirent>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| -------------------------------- | ------------- |
| Promise
<
[Dirent](#dirent)
>
| Promise对象。返回表示异步读取目录项的结果。 |
| 类型 | 说明 |
| -------------------------------- | ------------- |
| Promise
<
[Dirent](#dirent)
>
| Promise对象。返回表示异步读取目录项的结果。 |
**示例:**
```
js
...
...
@@ -2956,9 +2956,9 @@ read(callback: AsyncCallback<Dirent>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ---------------- |
| callback | AsyncCallback
<
[Dirent](#dirent)
>
| 是 | 异步读取下一个目录项之后的回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ---------------- |
| callback | AsyncCallback
<
[Dirent](#dirent)
>
| 是 | 异步读取下一个目录项之后的回调。 |
**示例:**
```
js
...
...
@@ -2981,9 +2981,9 @@ readSync(): Dirent
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ----------------- | -------- |
|
[
Dirent
](
#dirent
)
| 表示一个目录项。 |
| 类型 | 说明 |
| ----------------- | -------- |
|
[
Dirent
](
#dirent
)
| 表示一个目录项。 |
**示例:**
```
js
...
...
@@ -3063,9 +3063,9 @@ isBlockDevice(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------- | ---------------- |
| boolean | 表示当前目录项是否是块特殊设备。 |
| 类型 | 说明 |
| ------- | ---------------- |
| boolean | 表示当前目录项是否是块特殊设备。 |
**示例:**
```
js
...
...
@@ -3083,9 +3083,9 @@ isCharacterDevice(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------- | ----------------- |
| boolean | 表示当前目录项是否是字符特殊设备。 |
| 类型 | 说明 |
| ------- | ----------------- |
| boolean | 表示当前目录项是否是字符特殊设备。 |
**示例:**
```
js
...
...
@@ -3103,9 +3103,9 @@ isDirectory(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------- | ------------- |
| boolean | 表示当前目录项是否是目录。 |
| 类型 | 说明 |
| ------- | ------------- |
| boolean | 表示当前目录项是否是目录。 |
**示例:**
```
js
...
...
@@ -3123,9 +3123,9 @@ isFIFO(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------- | --------------- |
| boolean | 表示当前目录项是否是FIFO。 |
| 类型 | 说明 |
| ------- | --------------- |
| boolean | 表示当前目录项是否是FIFO。 |
**示例:**
```
js
...
...
@@ -3143,9 +3143,9 @@ isFile(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------- | --------------- |
| boolean | 表示当前目录项是否是普通文件。 |
| 类型 | 说明 |
| ------- | --------------- |
| boolean | 表示当前目录项是否是普通文件。 |
**示例:**
```
js
...
...
@@ -3163,9 +3163,9 @@ isSocket(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------- | -------------- |
| boolean | 表示当前目录项是否是套接字。 |
| 类型 | 说明 |
| ------- | -------------- |
| boolean | 表示当前目录项是否是套接字。 |
**示例:**
```
js
...
...
@@ -3183,9 +3183,9 @@ isSymbolicLink(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
| 类型 | 说明 |
| ------- | --------------- |
| boolean | 表示当前目录项是否是符号链接。 |
| 类型 | 说明 |
| ------- | --------------- |
| boolean | 表示当前目录项是否是符号链接。 |
**示例:**
```
js
...
...
zh-cn/application-dev/reference/apis/js-apis-i18n.md
浏览文件 @
80252784
# 国际化-I18n
本模块提供系统相关的或者增强的国际化能力,包括区域管理、电话号码处理、日历等,相关接口为ECMA 402标准中未定义的补充接口。
[
Intl模块
](
js-apis-intl.md
)
提供了ECMA 402标准定义的基础国际化接口,与本模块共同使用可提供完整地国际化支持能力。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
...
...
zh-cn/application-dev/reference/apis/js-apis-image.md
浏览文件 @
80252784
# 图片处理
本模块提供图片处理效果,包括通过属性创建PixelMap、读取图像像素数据、读取区域内的图片数据等。
> **说明:**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
浏览文件 @
80252784
# 输入法框架
本模块提供对输入法框架的管理,包括隐藏输入法、查询已安装的输入法列表和显示输入法选择对话框。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
@@ -47,7 +49,7 @@ getInputMethodController(): InputMethodController
| [InputMethodController](#InputMethodController) | 回调返回当前客户端实例。 |
**示例:**
```
js
var
InputMethodController
=
inputMethod
.
getInputMethodController
();
```
...
...
@@ -62,9 +64,9 @@ getInputMethodSetting(): InputMethodSetting
**返回值:**
| 类型 | 说明 |
| ----------------------------------------- | ---------------------------- |
|
[
InputMethodSetting
](
#InputMethodSetting
)
| 回调返回当前客户端设置实例。 |
| 类型 | 说明 |
| ----------------------------------------- | ---------------------------- |
|
[
InputMethodSetting
](
#InputMethodSetting
)
| 回调返回当前客户端设置实例。 |
**示例:**
...
...
@@ -87,9 +89,9 @@ stopInput(callback: AsyncCallback<boolean>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 返回输入法隐藏是否成功。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 返回输入法隐藏是否成功。 |
**示例:**
...
...
@@ -109,9 +111,9 @@ stopInput(): Promise<boolean>
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
boolean
>
| 返回输入法隐藏是否成功。 |
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
boolean
>
| 返回输入法隐藏是否成功。 |
**示例:**
...
...
@@ -134,12 +136,12 @@ listInputMethod(callback: AsyncCallback<Array<InputMethodProperty>>)
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------------- | ---- | ---------------------- |
| callback | Array
<
[
InputMethodProperty
](
#InputMethodProperty
)
>
| 是 | 返回已安装输入法列表。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------------- | ---- | ---------------------- |
| callback | Array
<
[
InputMethodProperty
](
#InputMethodProperty
)
>
| 是 | 返回已安装输入法列表。 |
**示例:**
```
js
InputMethodSetting
.
listInputMethod
((
properties
)
=>
{
for
(
var
i
=
0
;
i
<
properties
.
length
;
i
++
)
{
...
...
@@ -158,9 +160,9 @@ listInputMethod(): Array<InputMethodProperty>
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------------------- | ---------------------- |
| Promise
<Array
<[
InputMethodProperty
](
#InputMethodProperty
)
>
> | 返回已安装输入法列表。 |
| 类型 | 说明 |
| ----------------------------------------------------------- | ---------------------- |
| Promise
<Array
<[
InputMethodProperty
](
#InputMethodProperty
)
>
> | 返回已安装输入法列表。 |
**示例:**
...
...
zh-cn/application-dev/reference/apis/js-apis-intl.md
浏览文件 @
80252784
# 国际化-Intl
本模块提供提供基础的应用国际化能力,包括时间日期格式化、数字格式化、排序等,相关接口在ECMA 402标准中定义。
[
I18N模块
](
js-apis-i18n.md
)
提供其他非ECMA 402定义的国际化接口,与本模块共同使用可提供完整地国际化支持能力。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
...
...
zh-cn/application-dev/reference/apis/js-apis-logs.md
浏览文件 @
80252784
# 日志打印
本模块提供日志打印能力,包括打印debug级别的日志信息、打印info级别的日志信息、打印warn级别的日志信息和打印error级别的日志信息。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 从API Version 7 开始,该接口不再维护,推荐使用新接口[`@ohos.hilog`](js-apis-hilog.md)。
...
...
zh-cn/application-dev/reference/apis/js-apis-mediaquery.md
浏览文件 @
80252784
# 媒体查询
提供根据不同媒体类型定义不同的样式。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-prompt.md
浏览文件 @
80252784
# 弹窗
创建并显示文本提示框、对话框和操作菜单。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-router.md
浏览文件 @
80252784
# 页面路由
本模块提供通过不同的url访问不同的页面,包括跳转到应用内的指定页面、用应用内的某个页面替换当前页面、返回上一页面或指定的页面等。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明**
>
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-system-mediaquery.md
浏览文件 @
80252784
# 媒体查询
提供根据不同媒体类型定义不同的样式。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
>
...
...
zh-cn/application-dev/reference/apis/js-apis-system-prompt.md
浏览文件 @
80252784
# 弹窗
创建并显示文本提示框、对话框和操作菜单。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
>
> - 从API Version 8 开始,该接口不再维护,推荐使用新接口[`@ohos.prompt`](js-apis-prompt.md)。
...
...
zh-cn/application-dev/reference/apis/js-apis-system-router.md
浏览文件 @
80252784
# 页面路由
通过不同的uri访问不同的页面。
> **说明:**
>
> - 从API Version 8 开始,该接口不再维护,推荐使用新接口[`@ohos.router`](js-apis-router.md)。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md
浏览文件 @
80252784
# Button
按钮组件,可快速创建不同样式的按钮。
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
提供按钮组件。
## 权限列表
无
...
...
@@ -23,10 +22,10 @@
**表1**
options参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| type | ButtonType | 否 | Capsule | 描述按钮风格。 |
| stateEffect | boolean | 否 | true | 按钮按下时是否开启切换效果,当状态置为false时,点击效果关闭。 |
| type | ButtonType | 否 | Capsule | 描述按钮风格。 |
| stateEffect | boolean | 否 | true | 按钮按下时是否开启切换效果,当状态置为false时,点击效果关闭。 |
-
Button(label?: string, options?: { type?: ButtonType, stateEffect?: boolean })
...
...
@@ -49,11 +48,11 @@
| stateEffect | boolean | true | 状态切换时是否开启切换效果,当状态置为false时,点击效果关闭。 |
-
ButtonType枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| Capsule | 胶囊型按钮(圆角默认为高度的一半)。 |
| Circle | 圆形按钮。 |
| Normal | 普通按钮(默认不带圆角)。 |
| Capsule | 胶囊型按钮(圆角默认为高度的一半)。 |
| Circle | 圆形按钮。 |
| Normal | 普通按钮(默认不带圆角)。 |
> **说明:**
> - 按钮圆角通过[通用属性borderRadius设置](ts-universal-attributes-border.md)(不支持通过border接口设置圆角)。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md
浏览文件 @
80252784
# LoadingProgress
用于显示加载动效的组件。
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
用于显示加载进展。
## 权限列表
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md
浏览文件 @
80252784
# QRCode
用于显示单个二维码的组件。
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
显示二维码信息。
## 权限列表
无
...
...
@@ -22,16 +21,16 @@
QRCode(value: string)
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| value | string | 是 | - | 二维码内容字符串。 |
| value | string | 是 | - | 二维码内容字符串。 |
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| color | Color | Black | 设置二维码颜色。 |
| color | Color | Black | 设置二维码颜色。 |
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-rating.md
浏览文件 @
80252784
# Rating
提供在给定范围内选择评分的组件。
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
评分条组件。
## 权限列表
无
...
...
@@ -22,26 +21,26 @@
Rating(options?: { rating: number, indicator?: boolean })
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| rating | number | 是 | 0 | 设置并接收评分值。 |
| indicator | boolean | 否 | false | 仅作为指示器使用,不可操作。 |
| rating | number | 是 | 0 | 设置并接收评分值。 |
| indicator | boolean | 否 | false | 仅作为指示器使用,不可操作。 |
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| stars | number | 5 | 设置评星总数。 |
| stepSize | number | 0.5 | 操作评级的步长。 |
| starStyle | {
<br/>
backgroundUri:
string,
<br/>
foregroundUri:
string,
<br/>
secondaryUri?:
string
<br/>
} | - | backgroundSrc:未选中的星级的图片链接,可由用户自定义或使用系统默认图片,仅支持本地。
<br/>
foregroundSrc:选中的星级的图片路径,可由用户自定义或使用系统默认图片,仅支持本地。
<br/>
secondarySrc:部分选中的星级的图片路径,可由用户自定义或使用系统默认图片,仅支持本地。 |
| stars | number | 5 | 设置评星总数。 |
| stepSize | number | 0.5 | 操作评级的步长。 |
| starStyle | {
<br/>
backgroundUri:
string,
<br/>
foregroundUri:
string,
<br/>
secondaryUri?:
string
<br/>
} | - | backgroundSrc:未选中的星级的图片链接,可由用户自定义或使用系统默认图片,仅支持本地。
<br/>
foregroundSrc:选中的星级的图片路径,可由用户自定义或使用系统默认图片,仅支持本地。
<br/>
secondarySrc:部分选中的星级的图片路径,可由用户自定义或使用系统默认图片,仅支持本地。 |
## 事件
| 名称 | 功能描述 |
| 名称 | 功能描述 |
| -------- | -------- |
| onChange(callback:(value:
number)
=
>
void) | 操作评分条的评星发生改变时触发该回调。 |
| onChange(callback:(value:
number)
=
>
void) | 操作评分条的评星发生改变时触发该回调。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md
浏览文件 @
80252784
# Span
作为Text组件的子组件,用于显示行内文本的组件。
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
文本段落,只能作为Text子组件,呈现一段文本信息。
## 权限列表
无
...
...
@@ -22,9 +21,9 @@
Span(content: string)
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| content | string | 是 | - | 文本内容。 |
| content | string | 是 | - | 文本内容。 |
## 属性
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md
浏览文件 @
80252784
# Stepper
应用步骤方式切换页面的组件。
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
步骤导航器。
## 权限列表
无
...
...
@@ -24,9 +23,9 @@ Stepper(value?: { index?: number })
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| index | number | 否 | 0 | 设置步骤导航器显示第几个StepperItem。 |
| index | number | 否 | 0 | 设置步骤导航器显示第几个StepperItem。 |
## 属性
...
...
@@ -36,11 +35,11 @@ Stepper(value?: { index?: number })
## 事件
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| onFinish(callback:
()
=
>
void) | 步骤导航器最后一个StepperItem的nextLabel被点击时触发该回调
。 |
| onSkip(callback:
()
=
>
void) | 当前显示的StepperItem状态为ItemState.Skip时,nextLabel被点击时触发该回调。 |
| onChange(callback:
(prevIndex?:
number,
index?:
number)
=
>
void) | 点击左边或者右边文本按钮进行步骤切换时触发该事件。
<br/>
-
prevIndex:切换前的步骤页索引值。
<br/>
-
index:切换后的步骤页(前一页或者下一页)索引值。 |
| onFinish(callback:
()
=
>
void) | 步骤导航器最后一个StepperItem的nextLabel被点击时触发该回调
。 |
| onSkip(callback:
()
=
>
void) | 当前显示的StepperItem状态为ItemState.Skip时,nextLabel被点击时触发该回调。 |
| onChange(callback:
(prevIndex?:
number,
index?:
number)
=
>
void) | 点击左边或者右边文本按钮进行步骤切换时触发该事件。
<br/>
-
prevIndex:切换前的步骤页索引值。
<br/>
-
index:切换后的步骤页(前一页或者下一页)索引值。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepperitem.md
浏览文件 @
80252784
# StepperItem
用作
[
Stepper
](
ts-basic-components-stepper.md
)
组件的页面子组件。
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
步骤导航器元素。
## 权限列表
无
...
...
@@ -32,12 +31,12 @@ StepperItem()
| status | ItemState | ItemState.Normal | 步骤导航器元素的状态。 |
-
ItemState枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| Normal | 正常状态,右侧文本按钮正常显示,可点击进入下一个StepperItem。 |
| Disabled | 不可用状态,右侧文本按钮灰度显示,不可点击进入下一个StepperItem。 |
| Waiting | 等待状态,右侧文本按钮不显示,使用等待进度条,不可点击进入下一个StepperItem。 |
| Skip | 跳过状态,表示跳过当前步骤,
进入下一个StepperItem。 |
| Normal | 正常状态,右侧文本按钮正常显示,可点击进入下一个StepperItem。 |
| Disabled | 不可用状态,右侧文本按钮灰度显示,不可点击进入下一个StepperItem。 |
| Waiting | 等待状态,右侧文本按钮不显示,使用等待进度条,不可点击进入下一个StepperItem。 |
| Skip | 跳过状态,表示跳过当前步骤,
进入下一个StepperItem。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md
浏览文件 @
80252784
# Text
显示一段文本的组件。
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
文本,用于呈现一段信息。
## 权限列表
无
...
...
@@ -22,9 +21,9 @@
Text(content?: string)
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| content | string | 否 | '' | 文本内容,包含子组件Span时不生效,显示Span内容。 |
| content | string | 否 | '' | 文本内容,包含子组件Span时不生效,显示Span内容。 |
## 属性
...
...
@@ -41,26 +40,26 @@ Text(content?: string)
| copyOption
<sup>
9+
</sup>
| boolean
\|
CopyOption | false | 组件支持设置文本是否可复制粘贴。 |
-
TextAlign枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| Center | 文本居中对齐。 |
| Start | 根据文字书写相同的方向对齐。 |
| End | 根据文字书写相反的方向对齐。 |
| Center | 文本居中对齐。 |
| Start | 根据文字书写相同的方向对齐。 |
| End | 根据文字书写相反的方向对齐。 |
-
TextOverflow枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| Clip | 文本超长时进行裁剪显示。 |
| Ellipsis | 文本超长时显示不下的文本用省略号代替。 |
| None | 文本超长时不进行裁剪。 |
| Clip | 文本超长时进行裁剪显示。 |
| Ellipsis | 文本超长时显示不下的文本用省略号代替。 |
| None | 文本超长时不进行裁剪。 |
-
TextDecorationType枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| Underline | 文字下划线修饰。 |
| LineThrough | 穿过文本的修饰线。 |
| Overline | 文字上划线修饰。 |
| None | 不使用文本装饰线。 |
| Underline | 文字下划线修饰。 |
| LineThrough | 穿过文本的修饰线。 |
| Overline | 文字上划线修饰。 |
| None | 不使用文本装饰线。 |
-
TextCase枚举说明
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md
浏览文件 @
80252784
# TextArea
可以输入多行文本并支持响应部分输入事件的组件。
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
提供多行文本输入组件。
## 权限列表
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md
浏览文件 @
80252784
# TextInput
可以输入单行文本并支持响应输入事件的组件。
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
提供单行文本输入组件。
## 权限列表
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md
浏览文件 @
80252784
# TextPicker
滚动选择文本的组件。
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
文本类滑动选择器组件。
## 权限列表
无
...
...
@@ -24,24 +23,24 @@ TextPicker(value: {range: string[], selected?: number})
根据range指定的选择范围创建文本选择器。
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| range | string[] | 是 | - | 选择器的数据选择范围。 |
| selected | number | 否 | 第一个元素 | 选中项在数组中的index值。 |
| range | string[] | 是 | - | 选择器的数据选择范围。 |
| selected | number | 否 | 第一个元素 | 选中项在数组中的index值。 |
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| defaultPickerItemHeight | Length | - | 默认Picker内容项元素高度。 |
| defaultPickerItemHeight | Length | - | 默认Picker内容项元素高度。 |
## 事件
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| onChange(callback:
(value:
string,
index:
number)
=
>
void) | 滑动选中TextPicker文本内容后,触发该回调。
<br/>
-
value:
当前选中项的文本。
<br/>
-
index:
当前选中项的下标。 |
| onChange(callback:
(value:
string,
index:
number)
=
>
void) | 滑动选中TextPicker文本内容后,触发该回调。
<br/>
-
value:
当前选中项的文本。
<br/>
-
index:
当前选中项的下标。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md
浏览文件 @
80252784
# TextTimer
通过文本显示计时信息并控制其计时器状态的组件。
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
文本计时器组件,支持自定义时间格式。
## 权限列表
无
...
...
@@ -22,24 +21,24 @@
TextTimer(options: { isCountDown?: boolean, count?: number, controller?: TextTimerController })
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| isCountDown | boolean | 否 | false | 是否倒计时。 |
| count | number | 否 | 60000 | 倒计时时间(isCountDown为true时生效),单位为毫秒。
<br/>
-
count
<
=0时,使用默认值为倒计时初始值。
<br/>
-
count
>
0时,count值为倒计时初始值。 |
| controller |
[
TextTimerController
](
#texttimercontroller
)
| 否 | null | TextTimer控制器。 |
| isCountDown | boolean | 否 | false | 是否倒计时。 |
| count | number | 否 | 60000 | 倒计时时间(isCountDown为true时生效),单位为毫秒。
<br/>
-
count
<
=0时,使用默认值为倒计时初始值。
<br/>
-
count
>
0时,count值为倒计时初始值。 |
| controller |
[
TextTimerController
](
#texttimercontroller
)
| 否 | null | TextTimer控制器。 |
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| format | string | 'hh:mm:ss.ms' | 自定义格式,需至少包含一个hh、mm、ss、ms中的关键字。 |
| format | string | 'hh:mm:ss.ms' | 自定义格式,需至少包含一个hh、mm、ss、ms中的关键字。 |
## 事件
| 名称 | 功能描述 |
| 名称 | 功能描述 |
| -------- | -------- |
| onTimer(callback:
(utc:
number,
elapsedTime:
number)
=
>
void) | 时间文本发生变化时触发。
<br/>
utc:当前显示的时间,单位为毫秒。
<br/>
elapsedTime:计时器经过的时间,单位为毫秒。 |
| onTimer(callback:
(utc:
number,
elapsedTime:
number)
=
>
void) | 时间文本发生变化时触发。
<br/>
utc:当前显示的时间,单位为毫秒。
<br/>
elapsedTime:计时器经过的时间,单位为毫秒。 |
## TextTimerController
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-timepicker.md
浏览文件 @
80252784
# TimePicker
滚动选择时间的组件。
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
选择时间的滑动选择器组件。
## 权限列表
无
...
...
@@ -31,22 +30,22 @@ TimePicker(options?: TimePickerOptions)
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| useMilitaryTime | boolean | false | 展示时间是否为24小时制,不支持动态修改。 |
| useMilitaryTime | boolean | false | 展示时间是否为24小时制,不支持动态修改。 |
## 事件
| 名称 | 功能描述 |
| -------- | -------- |
| onChange(callback:
(value:
TimePickerResult )
=
>
void) | 选择时间时触发该事件。 |
| 名称 | 功能描述 |
| -------- | -------- |
| onChange(callback:
(value:
TimePickerResult )
=
>
void) | 选择时间时触发该事件。 |
### TimePickerResult对象说明
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| hour | number | 选中时间的时。 |
| minute | number | 选中时间的分。 |
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| hour | number | 选中时间的时。 |
| minute | number | 选中时间的分。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md
浏览文件 @
80252784
# Toggle
组件提供勾选框样式、状态按钮样式及开关样式。
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -28,7 +30,7 @@ Toggle(options: { type: ToggleType, isOn?: boolean })
-
ToggleType枚举说明
| 名称 | 描述 |
| -------- | -------- |
| Checkbox | 提供
单
选框样式,子组件设置文本不生效,如需文本设置,可将Text和当前组件放入布局组件中。
<br>
>
**说明:**
<br/>
>
[通用属性padding](ts-universal-attributes-size.md)的默认值为:
<br>
{
<br>
top: 14 vp,
<br>
right: 6 vp,
<br>
bottom: 14 vp,
<br>
left: 6 vp
<br>
} |
| Checkbox | 提供
勾
选框样式,子组件设置文本不生效,如需文本设置,可将Text和当前组件放入布局组件中。
<br>
>
**说明:**
<br/>
>
[通用属性padding](ts-universal-attributes-size.md)的默认值为:
<br>
{
<br>
top: 14 vp,
<br>
right: 6 vp,
<br>
bottom: 14 vp,
<br>
left: 6 vp
<br>
} |
| Button | 提供状态按钮样式,如果有文本设置,则相应的文本内容会显示在按钮内部。 |
| Switch | 提供开关样式,子组件设置文本不生效,如需文本设置,可将Text和当前组件放入布局组件中。
<br>
>
**说明:**
<br/>
>
[通用属性padding](ts-universal-attributes-size.md)默认值为:
<br>
{
<br/>
top: 12 vp,
<br/>
right: 12 vp,
<br/>
bottom: 12 vp,
<br/>
left: 12 vp
<br/>
} |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md
浏览文件 @
80252784
# LongPressGesture
用于触发长按手势事件,触发长按手势的最少手指数为1,最短时间为500毫秒。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -14,25 +16,25 @@
LongPressGesture(options?: { fingers?: number, repeat?: boolean, duration?: number })
-
参数
| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| fingers | number | 否 | 1 | 触发长按的最少手指数,最小为1指,
最大取值为10指。 |
| repeat | boolean | 否 | false | 是否连续触发事件回调。 |
| duration | number | 否 | 500 | 最小触发长按的时间,单位为毫秒(ms)。 |
| fingers | number | 否 | 1 | 触发长按的最少手指数,最小为1指,
最大取值为10指。 |
| repeat | boolean | 否 | false | 是否连续触发事件回调。 |
| duration | number | 否 | 500 | 最小触发长按的时间,单位为毫秒(ms)。 |
## 事件
| 名称 | 功能描述 |
| -------- | -------- |
| onAction((event?:
GestureEvent)
=
>
void) | LongPress手势识别成功回调。 |
| onActionEnd((event?:
GestureEvent)
=
>
void) | LongPress手势识别成功,手指抬起后触发回调。 |
| onActionCancel(event:
()
=
>
void) | LongPress手势识别成功,接收到触摸取消事件触发回调。 |
| 名称 | 功能描述 |
| -------- | -------- |
| onAction((event?:
GestureEvent)
=
>
void) | LongPress手势识别成功回调。 |
| onActionEnd((event?:
GestureEvent)
=
>
void) | LongPress手势识别成功,手指抬起后触发回调。 |
| onActionCancel(event:
()
=
>
void) | LongPress手势识别成功,接收到触摸取消事件触发回调。 |
-
GestureEvent对象中与LongPress手势相关的属性
| 属性名称 | 属性类型 | 描述 |
| 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- |
| repeat | boolean | 事件是否为重复触发事件。 |
| repeat | boolean | 事件是否为重复触发事件。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md
浏览文件 @
80252784
# PanGesture
用于触发拖动手势事件,滑动的最小距离为5vp时拖动手势识别成功。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -21,16 +23,16 @@ PanGesture(options?: { fingers?: number, direction?: PanDirection, distance?: nu
| distance | number | 否 | 5.0 | 最小滑动识别距离,单位为vp。 |
-
PanDirection枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| All | 所有方向可滑动。 |
| Horizontal | 水平方向可滑动。 |
| Vertical | 竖直方向可滑动。 |
| Left | 向左滑动。 |
| Right | 向右滑动。 |
| Up | 向上滑动。 |
| Down | 向下滑动。 |
| None | 任何方向都不可滑动。 |
| All | 所有方向可滑动。 |
| Horizontal | 水平方向可滑动。 |
| Vertical | 竖直方向可滑动。 |
| Left | 向左滑动。 |
| Right | 向右滑动。 |
| Up | 向上滑动。 |
| Down | 向下滑动。 |
| None | 任何方向都不可滑动。 |
### PanGestureOptions
...
...
@@ -43,27 +45,27 @@ PanGestureOptions(options?: { fingers?: number, direction?: PanDirection, distan
同PanGesture参数说明。
-
接口
| 名称 | 功能描述 |
| 名称 | 功能描述 |
| -------- | -------- |
| setDirection(value:
PanDirection) | 设置direction属性。 |
| setDistance(value:
number) | 设置distance属性。 |
| setFingers(value:
number) | 设置fingers属性。 |
| setDirection(value:
PanDirection) | 设置direction属性。 |
| setDistance(value:
number) | 设置distance属性。 |
| setFingers(value:
number) | 设置fingers属性。 |
## 事件
| 名称 | 功能描述 |
| -------- | -------- |
| onActionStart(callback:
(event?:
GestureEvent)
=
>
void) | Pan手势识别成功回调。 |
| onActionUpdate(callback:
(event?:
GestureEvent)
=
>
void) | Pan手势移动过程中回调。 |
| onActionEnd(callback:
(event?:
GestureEvent)
=
>
void) | Pan手势识别成功,手指抬起后触发回调。 |
| onActionCancel(callback:
()
=
>
void) | Pan手势识别成功,接收到触摸取消事件触发回调。 |
| 名称 | 功能描述 |
| -------- | -------- |
| onActionStart(callback:
(event?:
GestureEvent)
=
>
void) | Pan手势识别成功回调。 |
| onActionUpdate(callback:
(event?:
GestureEvent)
=
>
void) | Pan手势移动过程中回调。 |
| onActionEnd(callback:
(event?:
GestureEvent)
=
>
void) | Pan手势识别成功,手指抬起后触发回调。 |
| onActionCancel(callback:
()
=
>
void) | Pan手势识别成功,接收到触摸取消事件触发回调。 |
-
GestureEvent对象中与Pan手势相关的属性
| 属性名称 | 属性类型 | 描述 |
| 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- |
| offsetX | number | 手势事件偏移量,单位为vp。 |
| offsetY | number | 手势事件偏移量,单位为vp。 |
| offsetX | number | 手势事件偏移量,单位为vp。 |
| offsetY | number | 手势事件偏移量,单位为vp。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md
浏览文件 @
80252784
# PinchGesture
用于触发捏合手势,触发捏合手势的最少手指为2指,最大为5指,最小识别距离为3vp。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -14,27 +16,27 @@
PinchGesture(options?: { fingers?: number, distance?: number })
-
参数
| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| fingers | number | 否 | 2 | 触发捏合的最少手指数,
最小为2指,最大为5指。 |
| distance | number | 否 | 3.0 | 最小识别距离,单位为vp。 |
| fingers | number | 否 | 2 | 触发捏合的最少手指数,
最小为2指,最大为5指。 |
| distance | number | 否 | 3.0 | 最小识别距离,单位为vp。 |
## 事件
| 名称 | 功能描述 |
| -------- | -------- |
| onActionStart((event?:
GestureEvent)
=
>
void) | Pinch手势识别成功回调。 |
| onActionUpdate((event?:
GestureEvent)
=
>
void) | Pinch手势移动过程中回调。 |
| onActionEnd((event?:
GestureEvent)
=
>
void) | Pinch手势识别成功,手指抬起后触发回调。 |
| onActionCancel(event:
()
=
>
void) | Pinch手势识别成功,接收到触摸取消事件触发回调。 |
| 名称 | 功能描述 |
| -------- | -------- |
| onActionStart((event?:
GestureEvent)
=
>
void) | Pinch手势识别成功回调。 |
| onActionUpdate((event?:
GestureEvent)
=
>
void) | Pinch手势移动过程中回调。 |
| onActionEnd((event?:
GestureEvent)
=
>
void) | Pinch手势识别成功,手指抬起后触发回调。 |
| onActionCancel(event:
()
=
>
void) | Pinch手势识别成功,接收到触摸取消事件触发回调。 |
-
GestureEvent对象中与Pinch手势相关的属性
| 属性名称 | 属性类型 | 描述 |
| 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- |
| scale | number | 缩放比例,用于PinchGesture手势触发场景。 |
| pinchCenterX | number | 捏合手势中心点X轴坐标,单位为px。 |
| pinchCenterY | number | 捏合手势中心点Y轴坐标,单位为px。 |
| scale | number | 缩放比例,用于PinchGesture手势触发场景。 |
| pinchCenterX | number | 捏合手势中心点X轴坐标,单位为px。 |
| pinchCenterY | number | 捏合手势中心点Y轴坐标,单位为px。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md
浏览文件 @
80252784
# RotationGesture
用于触发旋转手势事件,触发旋转手势的最少手指为2指,最大为5指,最小改变度数为1度。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -14,25 +16,25 @@
RotationGesture(options?: { fingers?: number, angle?: number })
-
参数
| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| fingers | number | 否 | 2 | 触发旋转的最少手指数,
最小为2指,最大为5指。 |
| angle | number | 否 | 1.0 | 触发旋转手势的最小改变度数,单位为度数。 |
| fingers | number | 否 | 2 | 触发旋转的最少手指数,
最小为2指,最大为5指。 |
| angle | number | 否 | 1.0 | 触发旋转手势的最小改变度数,单位为度数。 |
## 事件
| 名称 | 功能描述 |
| 名称 | 功能描述 |
| -------- | -------- |
| onActionStart((event?:
GestureEvent)
=
>
void) | Rotation手势识别成功回调。 |
| onActionUpdate((event?:
GestureEvent)
=
>
void) | Rotation手势移动过程中回调。 |
| onActionEnd((event?:
GestureEvent)
=
>
void) | Rotation手势识别成功,手指抬起后触发回调。 |
| onActionCancel(event:
()
=
>
void) | Rotation手势识别成功,接收到触摸取消事件触发回调。 |
| onActionStart((event?:
GestureEvent)
=
>
void) | Rotation手势识别成功回调。 |
| onActionUpdate((event?:
GestureEvent)
=
>
void) | Rotation手势移动过程中回调。 |
| onActionEnd((event?:
GestureEvent)
=
>
void) | Rotation手势识别成功,手指抬起后触发回调。 |
| onActionCancel(event:
()
=
>
void) | Rotation手势识别成功,接收到触摸取消事件触发回调。 |
-
GestureEvent对象中与Rotation手势相关的属性
| 属性名称 | 属性类型 | 描述 |
| 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- |
| angle | number | 旋转角度。 |
| angle | number | 旋转角度。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md
浏览文件 @
80252784
# SwipeGesture
用于触发滑动事件,滑动最小速度为100vp/s时识别成功。
> **说明:**
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -21,25 +23,25 @@ SwipeGesture(value?: { fingers?: number; direction?: SwipeDirection; speed?: num
| speed | number | 否 | 100 | 识别滑动的最小速度(100VP/秒)。 |
-
SwipeDirection枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| All | 所有方向。 |
| Horizontal | 水平方向。 |
| Vertical | 竖直方向。 |
| All | 所有方向。 |
| Horizontal | 水平方向。 |
| Vertical | 竖直方向。 |
## 事件
| 名称 | 功能描述 |
| 名称 | 功能描述 |
| -------- | -------- |
| onAction(callback:(event?:
GestureEvent)
=
>
void) | 滑动手势识别成功回调。 |
| onAction(callback:(event?:
GestureEvent)
=
>
void) | 滑动手势识别成功回调。 |
-
GestureEvent对象中与Swipe手势相关的属性
| 参数名 | 类型 | 说明 |
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| angle | number | 滑动手势的角度,即两根手指间的线段与水平方向的夹角变化的度数。
<br/>
>
**说明:**
<br/>
>
角度计算方式:滑动手势被识别到后,连接两根手指之间的线被识别为起始线条,随着手指的滑动,手指之间的线条会发生旋转,根据起始线条两端点和当前线条两端点的坐标,使用反正切函数分别计算其相对于水平方向的夹角,最后arctan2(cy2-cy1,cx2-cx1)-arctan2(y2-y1,x2-x1)为旋转的角度。以起始线条为坐标系,顺时针旋转为0到180度,逆时针旋转为-180到0度。 |
| speed | number | 滑动手势的速度,是所有手指滑动的平均速度,单位为VP/秒。 |
| angle | number | 滑动手势的角度,即两根手指间的线段与水平方向的夹角变化的度数。
<br/>
>
**说明:**
<br/>
>
角度计算方式:滑动手势被识别到后,连接两根手指之间的线被识别为起始线条,随着手指的滑动,手指之间的线条会发生旋转,根据起始线条两端点和当前线条两端点的坐标,使用反正切函数分别计算其相对于水平方向的夹角,最后arctan2(cy2-cy1,cx2-cx1)-arctan2(y2-y1,x2-x1)为旋转的角度。以起始线条为坐标系,顺时针旋转为0到180度,逆时针旋转为-180到0度。 |
| speed | number | 滑动手势的速度,是所有手指滑动的平均速度,单位为VP/秒。 |
![
zh-cn_image_0000001231374559
](
figures/zh-cn_image_0000001231374661.png
)
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md
浏览文件 @
80252784
# TapGesture
支持单次点击、多次点击识别。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -14,17 +16,17 @@
TapGesture(options?: { count?: number, fingers?: number })
-
参数
| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| count | number | 否 | 1 | 识别的连续点击次数。如果设置小于1,会被转化为默认值。
<br/>
>
**说明:**
<br/>
>
如配置多击,上一次抬起和下一次按下的超时时间为300毫秒(ms)。 |
| fingers | number | 否 | 1 | 触发点击的最少手指数,最小为1指,
最大为10指。
<br/>
>
**说明:**
<br/>
>
1.
当配置多指时,第一根手指按下后300毫秒(ms)内未有足够的手指数按下,手势识别失败。
<br/>
>
<br/>
>
2.
实际点击手指数超过配置值,手势识别失败。 |
| count | number | 否 | 1 | 识别的连续点击次数。如果设置小于1,会被转化为默认值。
<br/>
>
**说明:**
<br/>
>
如配置多击,上一次抬起和下一次按下的超时时间为300毫秒(ms)。 |
| fingers | number | 否 | 1 | 触发点击的最少手指数,最小为1指,
最大为10指。
<br/>
>
**说明:**
<br/>
>
1.
当配置多指时,第一根手指按下后300毫秒(ms)内未有足够的手指数按下,手势识别失败。
<br/>
>
<br/>
>
2.
实际点击手指数超过配置值,手势识别失败。 |
## 事件
| 名称 | 功能描述 |
| -------- | -------- |
| onAction((event?:
[GestureEvent](ts-gesture-settings.md))
=
>
void) | Tap手势识别成功回调。 |
| 名称 | 功能描述 |
| -------- | -------- |
| onAction((event?:
[GestureEvent](ts-gesture-settings.md))
=
>
void) | Tap手势识别成功回调。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md
浏览文件 @
80252784
# 组合手势
手势识别组,多种手势组合为复合手势,支持连续识别、并行识别和互斥识别。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -20,18 +22,18 @@ GestureGroup(mode: GestureMode, ...gesture: GestureType[])
| gesture |
[
TapGesture
](
ts-basic-gestures-tapgesture.md
)
<br/>
\|
[LongPressGesture](ts-basic-gestures-longpressgesture.md)
<br/>
\|
[PanGesture](ts-basic-gestures-pangesture.md)
<br/>
\|
[PinchGesture](ts-basic-gestures-pinchgesture.md)
<br/>
\|
[
RotationGesture
](
ts-basic-gestures-rotationgesture.md
)
| 是 | - | 可变长参数,1个或者多个基础手势类型,这些手势会被组合识别。 |
-
GestureMode枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| Sequence | 顺序识别,按照手势的注册顺序识别手势,直到所有手势识别成功。当有一个手势识别失败时,所有手势识别失败。 |
| Parallel | 并发识别,注册的手势同时识别,直到所有手势识别结束,手势识别互相不影响。 |
| Exclusive | 互斥识别,注册的手势同时识别,若有一个手势识别成功,则结束手势识别。 |
| Sequence | 顺序识别,按照手势的注册顺序识别手势,直到所有手势识别成功。当有一个手势识别失败时,所有手势识别失败。 |
| Parallel | 并发识别,注册的手势同时识别,直到所有手势识别结束,手势识别互相不影响。 |
| Exclusive | 互斥识别,注册的手势同时识别,若有一个手势识别成功,则结束手势识别。 |
## 事件
| 名称 | 功能描述 |
| 名称 | 功能描述 |
| -------- | -------- |
| onCancel(event:
()
=
>
void) | 顺序组合手势(GestureMode.Sequence)取消后触发回调。 |
| onCancel(event:
()
=
>
void) | 顺序组合手势(GestureMode.Sequence)取消后触发回调。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-lottie.md
浏览文件 @
80252784
# Lottie
提供Lottie动画。
> **说明:**
> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md
浏览文件 @
80252784
# AlphabetIndexer
可以与容器组件联动用于按逻辑结构快速定位容器显示区域的组件。
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
字母索引条。
## 权限列表
无
...
...
@@ -23,32 +20,32 @@
AlphabetIndexer(value: {arrayValue : Array
<
string
>
, selected : number})
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| arrayValue | Array
<
string
>
| 是 | - | 字母索引字符串数组。 |
| selected | number | 是 | - | 选中项编号。 |
| arrayValue | Array
<
string
>
| 是 | - | 字母索引字符串数组。 |
| selected | number | 是 | - | 选中项编号。 |
## 属性
| 名称 | 参数类型 | 描述 |
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| selectedColor | Color | 选中文本文字颜色。 |
| popupColor | Color | 弹出提示文本字体颜色。 |
| selectedBackgroundColor | Color | 选中文本背景颜色。 |
| popupBackground | Color | 弹窗索引背景色。 |
| usingPopup | boolean | 是否使用弹出索引提示。 |
| selectedFont | {
<br/>
size?:
number,
<br/>
weight?:
FontWeight,
<br/>
family?:
string,
<br/>
style?:
FontStyle
<br/>
} | 选中文本文字样式。 |
| popupFont | {
<br/>
size?:
number,
<br/>
weight?:
FontWeight,
<br/>
family?:
string,
<br/>
style?:
FontStyle
<br/>
} | 弹出提示文本字体样式。 |
| font | {
<br/>
size?:
number,
<br/>
weight?:
FontWeight,
<br/>
family?:
string,
<br/>
style?:
FontStyle
<br/>
} | 字母索引条默认文本字体样式。 |
| itemSize | Length | 字母索引条字母区域大小,字母区域为正方形,设置正方形边长。 |
| alignStyle | IndexerAlign | 字母索引条对齐样式,支持左侧对齐样式与右侧对齐样式,影响弹窗弹出位置。 |
| selectedColor | Color | 选中文本文字颜色。 |
| popupColor | Color | 弹出提示文本字体颜色。 |
| selectedBackgroundColor | Color | 选中文本背景颜色。 |
| popupBackground | Color | 弹窗索引背景色。 |
| usingPopup | boolean | 是否使用弹出索引提示。 |
| selectedFont | {
<br/>
size?:
number,
<br/>
weight?:
FontWeight,
<br/>
family?:
string,
<br/>
style?:
FontStyle
<br/>
} | 选中文本文字样式。 |
| popupFont | {
<br/>
size?:
number,
<br/>
weight?:
FontWeight,
<br/>
family?:
string,
<br/>
style?:
FontStyle
<br/>
} | 弹出提示文本字体样式。 |
| font | {
<br/>
size?:
number,
<br/>
weight?:
FontWeight,
<br/>
family?:
string,
<br/>
style?:
FontStyle
<br/>
} | 字母索引条默认文本字体样式。 |
| itemSize | Length | 字母索引条字母区域大小,字母区域为正方形,设置正方形边长。 |
| alignStyle | IndexerAlign | 字母索引条对齐样式,支持左侧对齐样式与右侧对齐样式,影响弹窗弹出位置。 |
-
IndexerAlign枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| Left | 弹框显示在索引条右侧。 |
| Right | 弹框显示在索引条左侧。 |
| Left | 弹框显示在索引条右侧。 |
| Right | 弹框显示在索引条左侧。 |
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-badge.md
浏览文件 @
80252784
# Badge
可以附加在单个组件上用于信息标记的容器组件。
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
新事件标记组件,在组件上提供事件信息展示能力。
## 权限列表
无
...
...
@@ -49,11 +48,11 @@ Badge(value: {value: string, position?: BadgePosition, style?: BadgeStyle})
| badgeColor | Color | 否 | Color.Red | badge的颜色。 |
-
BadgePosition枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| Right | 圆点显示在右侧纵向居中。 |
| RightTop | 圆点显示在右上角。 |
| Left | 圆点显示在左侧纵向居中。 |
| Right | 圆点显示在右侧纵向居中。 |
| RightTop | 圆点显示在右上角。 |
| Left | 圆点显示在左侧纵向居中。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-flex.md
浏览文件 @
80252784
# Flex
应用弹性方式布局子组件的容器组件。
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
弹性布局组件。
## 权限列表
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md
浏览文件 @
80252784
# Refresh
可以进行页面下拉操作并显示刷新动效的容器组件。
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
下拉刷新容器。
## 权限列表
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-circle.md
浏览文件 @
80252784
# Circle
用于绘制圆形的组件。
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
圆形绘制组件。
## 权限列表
无
...
...
@@ -27,18 +26,18 @@ Circle(options?: {width: Length, height: Length})
| options | Object | 否 | - | 见options参数说明。 |
-
options参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| width | Length | 是 | - | 宽度。 |
| height | Length | 是 | - | 高度。 |
| width | Length | 是 | - | 宽度。 |
| height | Length | 是 | - | 高度。 |
## 属性
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| width | Length | 0 | 否 | 圆所在矩形的宽度。 |
| height | Length | 0 | 否 | 圆所在矩形的高度。 |
| width | Length | 0 | 否 | 圆所在矩形的宽度。 |
| height | Length | 0 | 否 | 圆所在矩形的高度。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-explicit-animation.md
浏览文件 @
80252784
# 显式动画
提供显示动画接口。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -12,20 +14,20 @@
## AnimationOptions对象说明
-
属性
| 属性名称 | 属性类型 | 默认值 | 描述 |
| 属性名称 | 属性类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| duration | number | 1000 | 动画持续时间,单位为毫秒。 |
| tempo | number | 1.0 | 动画的播放速度,值越大动画播放越快,值越小播放越慢,为0时无动画效果。 |
| curve | Curve
\|
Curves | Linear | 动画曲线。 |
| delay | number | 0 | 单位为ms(毫秒),默认不延时播放。 |
| iterations | number | 1 | 默认播放一次,设置为-1时表示无限次播放。 |
| playMode | PlayMode | Normal | 设置动画播放模式,默认播放完成后重头开始播放。 |
| duration | number | 1000 | 动画持续时间,单位为毫秒。 |
| tempo | number | 1.0 | 动画的播放速度,值越大动画播放越快,值越小播放越慢,为0时无动画效果。 |
| curve | Curve
\|
Curves | Linear | 动画曲线。 |
| delay | number | 0 | 单位为ms(毫秒),默认不延时播放。 |
| iterations | number | 1 | 默认播放一次,设置为-1时表示无限次播放。 |
| playMode | PlayMode | Normal | 设置动画播放模式,默认播放完成后重头开始播放。 |
-
接口
| 名称 | 功能描述 |
| 名称 | 功能描述 |
| -------- | -------- |
| onFinish()
=
>
void | 动效播放完成回调。 |
| onFinish()
=
>
void | 动效播放完成回调。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-gesture-settings.md
浏览文件 @
80252784
# 绑定手势方法
为组件绑定不同类型的手势事件,并设置事件的响应方法。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-interpolation-calculation.md
浏览文件 @
80252784
# 插值计算
设置动画插值曲线,用于构造阶梯曲线对象、构造三阶贝塞尔曲线对象和构造弹簧曲线对象。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -48,10 +50,10 @@ stepsCurve(count: number, end: boolean):ICurve
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ----| ------------------------------------------------------------ |
| count | number | 是 | 阶梯的数量,需要为正整数。 |
| end | boolean | 是 | 在每个间隔的起点或是终点发生阶跃变化。
<br>
-true:在终点发生阶跃变化。
<br>
-false:在起点发生阶跃变化。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ----| ------------------------------------------------------------ |
| count | number | 是 | 阶梯的数量,需要为正整数。 |
| end | boolean | 是 | 在每个间隔的起点或是终点发生阶跃变化。
<br>
-true:在终点发生阶跃变化。
<br>
-false:在起点发生阶跃变化。 |
**返回值:**
...
...
@@ -77,12 +79,12 @@ cubicBezierCurve(x1: number, y1: number, x2: number, y2: number):ICurve
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------------- |
| x1 | number | 是 | 确定贝塞尔曲线第一点横坐标。 |
| y1 | number | 是 | 确定贝塞尔曲线第一点纵坐标。 |
| x2 | number | 是 | 确定贝塞尔曲线第二点横坐标。 |
| y2 | number | 是 | 确定贝塞尔曲线第二点纵坐标。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------------- |
| x1 | number | 是 | 确定贝塞尔曲线第一点横坐标。 |
| y1 | number | 是 | 确定贝塞尔曲线第一点纵坐标。 |
| x2 | number | 是 | 确定贝塞尔曲线第二点横坐标。 |
| y2 | number | 是 | 确定贝塞尔曲线第二点纵坐标。 |
**返回值:**
...
...
@@ -185,10 +187,10 @@ steps(count: number, end: boolean): string
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ----| ------------------------------------------------------------ |
| count | number | 是 | 阶梯的数量,需要为正整数。 |
| end | boolean | 是 | 在每个间隔的起点或是终点发生阶跃变化。
<br>
-true:在终点发生阶跃变化。
<br>
-false:在起点发生阶跃变化。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ----| ------------------------------------------------------------ |
| count | number | 是 | 阶梯的数量,需要为正整数。 |
| end | boolean | 是 | 在每个间隔的起点或是终点发生阶跃变化。
<br>
-true:在终点发生阶跃变化。
<br>
-false:在起点发生阶跃变化。 |
## Curves.cubicBezier<sup>(deprecated)</sup>
...
...
@@ -200,12 +202,12 @@ cubicBezier(x1: number, y1: number, x2: number, y2: number): string
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------------- |
| x1 | number | 是 | 确定贝塞尔曲线第一点横坐标。 |
| y1 | number | 是 | 确定贝塞尔曲线第一点纵坐标。 |
| x2 | number | 是 | 确定贝塞尔曲线第二点横坐标。 |
| y2 | number | 是 | 确定贝塞尔曲线第二点纵坐标。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------------- |
| x1 | number | 是 | 确定贝塞尔曲线第一点横坐标。 |
| y1 | number | 是 | 确定贝塞尔曲线第一点纵坐标。 |
| x2 | number | 是 | 确定贝塞尔曲线第二点横坐标。 |
| y2 | number | 是 | 确定贝塞尔曲线第二点纵坐标。 |
## Curves.spring<sup>(deprecated)</sup>
...
...
@@ -227,21 +229,21 @@ spring(velocity: number, mass: number, stiffness: number, damping: number): stri
## Curve枚举说明
| 名称 | 描述 |
| ------------------- | ---------------------------------------- |
| Linear | 表示动画从头到尾的速度都是相同的。 |
| Ease | 表示动画以低速开始,然后加快,在结束前变慢,CubicBezier(0.25,
0.1,
0.25,
1.0)。 |
| EaseIn | 表示动画以低速开始,CubicBezier(0.42,
0.0,
1.0,
1.0)。 |
| EaseOut | 表示动画以低速结束,CubicBezier(0.0,
0.0,
0.58,
1.0)。 |
| EaseInOut | 表示动画以低速开始和结束,CubicBezier(0.42,
0.0,
0.58,
1.0)。 |
| FastOutSlowIn | 标准曲线,cubic-bezier(0.4,
0.0,
0.2,
1.0)。 |
| LinearOutSlowIn | 减速曲线,cubic-bezier(0.0,
0.0,
0.2,
1.0)。 |
| FastOutLinearIn | 加速曲线,cubic-bezier(0.4,
0.0,
1.0,
1.0)。 |
| ExtremeDeceleration | 急缓曲线,cubic-bezier(0.0,
0.0,
0.0,
1.0)。 |
| Sharp | 锐利曲线,cubic-bezier(0.33,
0.0,
0.67,
1.0)。 |
| Rhythm | 节奏曲线,cubic-bezier(0.7,
0.0,
0.2,
1.0)。 |
| Smooth | 平滑曲线,cubic-bezier(0.4,
0.0,
0.4,
1.0)。 |
| Friction | 阻尼曲线,CubicBezier(0.2,
0.0,
0.2,
1.0)。 |
| 名称 | 描述 |
| ------------------- | ---------------------------------------- |
| Linear | 表示动画从头到尾的速度都是相同的。 |
| Ease | 表示动画以低速开始,然后加快,在结束前变慢,CubicBezier(0.25,
0.1,
0.25,
1.0)。 |
| EaseIn | 表示动画以低速开始,CubicBezier(0.42,
0.0,
1.0,
1.0)。 |
| EaseOut | 表示动画以低速结束,CubicBezier(0.0,
0.0,
0.58,
1.0)。 |
| EaseInOut | 表示动画以低速开始和结束,CubicBezier(0.42,
0.0,
0.58,
1.0)。 |
| FastOutSlowIn | 标准曲线,cubic-bezier(0.4,
0.0,
0.2,
1.0)。 |
| LinearOutSlowIn | 减速曲线,cubic-bezier(0.0,
0.0,
0.2,
1.0)。 |
| FastOutLinearIn | 加速曲线,cubic-bezier(0.4,
0.0,
1.0,
1.0)。 |
| ExtremeDeceleration | 急缓曲线,cubic-bezier(0.0,
0.0,
0.0,
1.0)。 |
| Sharp | 锐利曲线,cubic-bezier(0.33,
0.0,
0.67,
1.0)。 |
| Rhythm | 节奏曲线,cubic-bezier(0.7,
0.0,
0.2,
1.0)。 |
| Smooth | 平滑曲线,cubic-bezier(0.4,
0.0,
0.4,
1.0)。 |
| Friction | 阻尼曲线,CubicBezier(0.2,
0.0,
0.2,
1.0)。 |
## 整体示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-matrix-transformation.md
浏览文件 @
80252784
# 矩阵变换
可对图形进行平移、旋转和缩放等。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md
浏览文件 @
80252784
# Video
用于播放单个视频并控制其播放状态的组件。
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
视频播放组件。
## 权限列表
使用网络视频时,需要在config或者module.json对应的"abilities"中添加网络使用权限ohos.permission.INTERNET。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md
浏览文件 @
80252784
# 菜单
在页面范围内关闭通过
[
bindContextMenu
](
./ts-universal-attributes-menu.md#属性
)
属性绑定的菜单。
> **说明:**
> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click.md
浏览文件 @
80252784
# 点击控制
设置组件是否可触摸。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-component-id.md
浏览文件 @
80252784
...
...
@@ -13,9 +13,9 @@ id为组件的唯一标识,在整个应用内唯一。本模块提供组件标
## 属性
| 名称 | 参数说明 | 默认值 | 描述 |
| 名称 | 参数说明 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| id | string | '' | 组件的唯一标识,唯一性由使用者保证。 |
| id | string | '' | 组件的唯一标识,唯一性由使用者保证。 |
## 接口
...
...
@@ -28,14 +28,14 @@ getInspectorByKey(id: string): string
获取指定id的组件的所有属性,不包括子组件信息。
-
参数
| 参数 | 类型 | 必填 | 默认值 | 描述 |
| 参数 | 类型 | 必填 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| id | string | 是 | - | 要获取属性的组件id。 |
| id | string | 是 | - | 要获取属性的组件id。 |
-
返回值
| 类型 | 描述 |
| 类型 | 描述 |
| -------- | -------- |
| string | 组件属性列表的JSON字符串。 |
| string | 组件属性列表的JSON字符串。 |
### getInspectorTree
...
...
@@ -56,16 +56,16 @@ sendEventByKey(id: string, action: number, params: string): boolean
给指定id的组件发送事件。
-
参数
| 参数 | 类型 | 必填 | 默认值 | 描述 |
| 参数 | 类型 | 必填 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| id | string | 是 | - | 要触发事件的组件的id。 |
| action | number | 是 | - | 要触发的事件类型,目前支持取值:
<br/>
-
点击事件Click:
10
<br/>
-
长按事件LongClick:
11。 |
| params | string | 是 | - | 事件参数,无参数传空字符串
""。 |
| id | string | 是 | - | 要触发事件的组件的id。 |
| action | number | 是 | - | 要触发的事件类型,目前支持取值:
<br/>
-
点击事件Click:
10
<br/>
-
长按事件LongClick:
11。 |
| params | string | 是 | - | 事件参数,无参数传空字符串
""。 |
-
返回值
| 类型 | 描述 |
| 类型 | 描述 |
| -------- | -------- |
| boolean | 找不到指定id的组件时返回false,其余情况返回true。 |
| boolean | 找不到指定id的组件时返回false,其余情况返回true。 |
### sendTouchEvent
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-enable.md
浏览文件 @
80252784
# 禁用控制
可交互状态下组件响应点击事件。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -12,9 +14,9 @@
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| enabled | boolean | true | 值为true表示组件可用,可响应点击等操作;值为false时,不响应点击等操作。 |
| enabled | boolean | true | 值为true表示组件可用,可响应点击等操作;值为false时,不响应点击等操作。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md
浏览文件 @
80252784
# 焦点控制
自定义组件的走焦效果,可设置组件是否走焦和具体的走焦顺序,tab键或者方向键切换焦点。
> **说明:**
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -11,9 +13,9 @@
## 属性
|
**名称**
|
**参数类型**
|
**默认值**
|
**描述**
|
|
**名称**
|
**参数类型**
|
**默认值**
|
**描述**
|
| -------- | -------- | -------- | -------- |
| focusable | boolean | false | 设置当前组件是否可以获焦。 |
| focusable | boolean | false | 设置当前组件是否可以获焦。 |
| tabIndex
<sup>
9+
<sup>
| number | 0 | 自定义组件tab键走焦能力,走焦顺序为:tabIndex大于0的组件依次递增走焦, tabIndex等于0的组件按组件树先后顺序走焦。
<br
/>
- tabIndex >= 0:表示元素是可聚焦的,并且可以通过tab键走焦来访问到该元素,按照tabIndex的数值递增而先后获焦。如果多个元素拥有相同的tabIndex,按照元素在当前组件树中的先后顺序获焦
<br
/>
- tabIndex < 0(通常是tabIndex = -1):表示元素是可聚焦的,但是不能通过tab键走焦来访问到该元素 |
> **说明:**
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-gradient-color.md
浏览文件 @
80252784
# 颜色渐变
设置组件的颜色渐变效果。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -22,17 +24,17 @@
-
GradientDirection枚举说明
<br>
GradientDirection用于描述渐变方向。
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| Left | 从右向左。 |
| Top | 从下向上。 |
| Right | 从左向右。 |
| Bottom | 从上向下。 |
| LeftTop | 左上。 |
| LeftBottom | 左下。 |
| RightTop | 右上。 |
| RightBottom | 右下。 |
| None | 无。 |
| Left | 从右向左。 |
| Top | 从下向上。 |
| Right | 从左向右。 |
| Bottom | 从上向下。 |
| LeftTop | 左上。 |
| LeftBottom | 左下。 |
| RightTop | 右上。 |
| RightBottom | 右下。 |
| None | 无。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-hover-effect.md
浏览文件 @
80252784
# 悬浮态效果
设置组件的鼠标悬浮态显示效果。
> **说明:**
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-image-effect.md
浏览文件 @
80252784
# 图像效果
例如背景模糊、内容模糊和灰度效果等。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-layout-constraints.md
浏览文件 @
80252784
# 布局约束
通过组件的宽高比和显示优先级约束组件显示效果。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -12,10 +14,10 @@
## 属性
| 名称 | 参数说明 | 默认值 | 描述 |
| 名称 | 参数说明 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| aspectRatio | number | - | 指定当前组件的宽高比。 |
| displayPriority | number | - | 设置当前组件在布局容器中显示的优先级,当父容器空间不足时,低优先级的组件会被隐藏。
<br/>
>
**说明:**
<br/>
>
仅在Row/Column/Flex(单行)容器组件中生效。 |
| aspectRatio | number | - | 指定当前组件的宽高比。 |
| displayPriority | number | - | 设置当前组件在布局容器中显示的优先级,当父容器空间不足时,低优先级的组件会被隐藏。
<br/>
>
**说明:**
<br/>
>
仅在Row/Column/Flex(单行)容器组件中生效。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-location.md
浏览文件 @
80252784
# 位置设置
设置组件的对齐方式、布局方向和显示位置。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -22,11 +24,11 @@
-
Direction枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| Ltr | 元素从左到右布局。 |
| Rtl | 元素从右到左布局。 |
| Auto | 使用系统默认布局方向。 |
| Ltr | 元素从左到右布局。 |
| Rtl | 元素从右到左布局。 |
| Auto | 使用系统默认布局方向。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md
浏览文件 @
80252784
# Menu控制
为组件绑定弹出式菜单,弹出式菜单以垂直列表形式显示菜单项,可通过长按、点击或鼠标右键触发。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-overlay.md
浏览文件 @
80252784
# 浮层
设置组件的遮罩文本。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md
浏览文件 @
80252784
# Popup控制
设置组件点击时弹出的气泡框状态。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -18,13 +20,13 @@
-
PopupOptions类型接口说明
| 名称 | 类型 | 必填 | 默认值 | 描述 |
| 名称 | 类型 | 必填 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| message | string | 是 | - | 弹窗信息内容。 |
| placementOnTop | boolean | 否 | false | 是否在组件上方显示,默认值为false。 |
| primaryButton | {
<br/>
value:
string,
<br/>
action:
()
=
>
void
<br/>
} | 否 | - | 第一个按钮。
<br/>
value:
弹窗里主按钮的文本。
<br/>
action:
点击主按钮的回调函数。 |
| secondaryButton | {
<br/>
value:
string,
<br/>
action:
()
=
>
void
<br/>
} | 否 | - | 第二个按钮。
<br/>
value:
弹窗里辅助按钮的文本。
<br/>
action:
点击辅助按钮的回调函数。 |
| onStateChange | (isVisible:
boolean)
=
>
void | 否 | - | 弹窗状态变化事件回调,参数isVisible为弹窗当前的显示状态。 |
| message | string | 是 | - | 弹窗信息内容。 |
| placementOnTop | boolean | 否 | false | 是否在组件上方显示,默认值为false。 |
| primaryButton | {
<br/>
value:
string,
<br/>
action:
()
=
>
void
<br/>
} | 否 | - | 第一个按钮。
<br/>
value:
弹窗里主按钮的文本。
<br/>
action:
点击主按钮的回调函数。 |
| secondaryButton | {
<br/>
value:
string,
<br/>
action:
()
=
>
void
<br/>
} | 否 | - | 第二个按钮。
<br/>
value:
弹窗里辅助按钮的文本。
<br/>
action:
点击辅助按钮的回调函数。 |
| onStateChange | (isVisible:
boolean)
=
>
void | 否 | - | 弹窗状态变化事件回调,参数isVisible为弹窗当前的显示状态。 |
-
CustomPopupOptions
<sup>
8+
</sup>
类型接口说明
| 名称 | 类型 | 必填 | 默认值 | 描述 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-sharp-clipping.md
浏览文件 @
80252784
# 形状裁剪
用于对组件进行裁剪、遮罩处理。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -12,10 +14,10 @@
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| clip | Shape
\|
boolean | false | 参数为Shape类型时,按指定的形状对当前组件进行裁剪;参数为boolean类型时,设置是否按照边缘轮廓进行裁剪。 |
| mask | Shape | - | 在当前组件上加上指定形状的遮罩。 |
| clip | Shape
\|
boolean | false | 参数为Shape类型时,按指定的形状对当前组件进行裁剪;参数为boolean类型时,设置是否按照边缘轮廓进行裁剪。 |
| mask | Shape | - | 在当前组件上加上指定形状的遮罩。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md
浏览文件 @
80252784
# 尺寸设置
用于设置组件的宽高、边距等显示尺寸进行设置。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-transformation.md
浏览文件 @
80252784
# 图形变换
用于对组件进行旋转、平移、缩放、矩阵变换等操作。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md
浏览文件 @
80252784
# 显隐控制
控制组件是否可见。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -18,11 +20,11 @@
-
Visibility枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| Hidden | 隐藏,但参与布局进行占位。 |
| Visible | 显示。 |
| None | 隐藏,但不参与布局,不进行占位。 |
| Hidden | 隐藏,但参与布局进行占位。 |
| Visible | 显示。 |
| None | 隐藏,但不参与布局,不进行占位。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-z-order.md
浏览文件 @
80252784
# Z序控制
组件的Z序,指明了该组件在堆叠组件中的位置。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -12,9 +14,9 @@
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| zIndex | number | 0 | 同一容器中兄弟组件显示层级关系,z值越大,显示层级越高。 |
| zIndex | number | 0 | 同一容器中兄弟组件显示层级关系,z值越大,显示层级越高。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-component-area-change-event.md
浏览文件 @
80252784
# 组件区域变化事件
组件区域变化事件指组件显示的尺寸、位置等发生变化时触发的事件。
> **说明:**
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -11,9 +13,9 @@
## 事件
| 名称 | 支持冒泡 | 功能描述 |
| -------- | -------- | -------- |
| onAreaChange(event:
(oldValue:
Area,
newValue:
Area)
=
>
void) | 否 | 组件区域变化时触发该回调,Area类型说明见
[
Area对象
](
ts-universal-events-click.md
)
介绍。 |
| 名称 | 支持冒泡 | 功能描述 |
| -------- | -------- | -------- |
| onAreaChange(event:
(oldValue:
Area,
newValue:
Area)
=
>
void) | 否 | 组件区域变化时触发该回调,Area类型说明见
[
Area对象
](
ts-universal-events-click.md
)
介绍。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md
浏览文件 @
80252784
# 点击事件
点击事件指组件被点击时触发的事件。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 支持设备
| 手机 | 平板 | 智慧屏 | 智能穿戴 |
| ---- | ---- | ------ | -------- |
| 支持 | 支持 | 不支持 | 不支持 |
## 权限列表
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md
浏览文件 @
80252784
# 拖拽事件
拖拽事件指被长按后拖拽时触发的事件。
> **说明:**
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md
浏览文件 @
80252784
# 按键事件
按键事件指组件与键盘、遥控器等按键设备交互时触发的事件。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-show-hide.md
浏览文件 @
80252784
# 挂载卸载事件
挂载卸载事件指组件从组件树上挂载、卸载时触发的事件。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md
浏览文件 @
80252784
# 触摸事件
当手指放在组件上、滑动或从组件上移开时触发。
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-focus-event.md
浏览文件 @
80252784
# 焦点事件
焦点事件指页面焦点在组件间移动时触发的事件,组件可使用焦点事件来更改内容。
> **说明:**
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
@@ -11,10 +13,10 @@
## 事件
|
**名称**
|
**支持冒泡**
|
**功能描述**
|
|
**名称**
|
**支持冒泡**
|
**功能描述**
|
| -------- | -------- | -------- |
| onFocus(callback:
()
=
>
void) | 否 | 当前组件获取焦点时触发的回调。 |
| onBlur(callback:()
=
>
void) | 否 | 当前组件失去焦点时触发的回调。 |
| onFocus(callback:
()
=
>
void) | 否 | 当前组件获取焦点时触发的回调。 |
| onBlur(callback:()
=
>
void) | 否 | 当前组件失去焦点时触发的回调。 |
> **说明:**
> 支持焦点事件的组件:Button、Text、Image、List、Grid。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md
浏览文件 @
80252784
# 鼠标事件
在单个动作触发多个事件时,事件的顺序是固定的,遵循xxx的顺序调用处理程序。
> **说明:**
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录