From b07cbe8d2329d559c0a26b2da01ac709c2a63086 Mon Sep 17 00:00:00 2001 From: sunjiakun Date: Thu, 6 Jul 2023 11:47:52 +0800 Subject: [PATCH] Add new progress properties Signed-off-by: sunjiakun --- .../arkui-ts/ts-basic-components-progress.md | 32 +++++++++++++++---- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md index 9547ba7c96..959378f998 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md @@ -60,33 +60,51 @@ Progress(options: {value: number, total?: number, type?: ProgressType}) | 名称 | 参数类型 | 描述 | | ------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | | value | number | 设置当前进度值。设置小于0的数值时置为0,设置大于total的数值时置为total。非法数值不生效。
从API version 9开始,该接口支持在ArkTS卡片中使用。 | -| color | [ResourceColor](ts-types.md#resourcecolor) \| [LinearGradient10+](ts-basic-components-datapanel.md#lineargradient10对象说明) | 设置进度条前景色。从API version 10开始支持利用LinearGradient设置Ring样式的渐变色。
默认值(API version 9):'\#ff007dff'
默认值(API version 10):
- Capsule:'\#33006cde'
- Ring:起始端:'\#ff3b61f7',结束端:'\#ff6591bf'
- 其他样式:'\#ff007dff'
从API version 9开始,该接口支持在ArkTS卡片中使用,暂不支持LinearGradient。 | +| color | [ResourceColor](ts-types.md#resourcecolor) \| [LinearGradient10+](ts-basic-components-datapanel.md#lineargradient10对象说明) | 设置进度条前景色。
从API version 10开始支持利用LinearGradient设置Ring样式的渐变色。
默认值(API version 9):'\#ff007dff'
默认值(API version 10):
- Capsule:'\#33006cde'
- Ring:起始端:'\#ff3b61f7',结束端:'\#ff6591bf'
- 其他样式:'\#ff007dff'
从API version 9开始,该接口支持在ArkTS卡片中使用,暂不支持LinearGradient。 | | backgroundColor | [ResourceColor](ts-types.md#resourcecolor) | 设置进度条底色。
默认值(API version 9):'\#19182431'
默认值(API version 10):
- Capsule:'\#33ffffff'
- Ring:'\#08182431'
- 其他样式:'\#19182431'
从API version 9开始,该接口支持在ArkTS卡片中使用。
**说明:**
当设置[通用属性backgroundColor](./ts-universal-attributes-background.md)时,生效的是进度条的底色,而不是整个Progress组件的背景色。 | -| style8+ | [ProgressStyleOptions](#progressstyleoptions) \| [CapsuleStyleOptions10+](#capsulestyleoptions10) \| [RingStyleOptions10+](#ringstyleoptions10) | 定义组件的样式。从API version 10开始追加CapsuleStyleOptions和RingStyleOptions类型。
- CapsuleStyleOptions用于设置Capsule的样式。
- RingStyleOptions用于设置Ring的样式。
- ProgressStyleOptions设置其他类型进度条的样式。
从API version 9开始,该接口支持在ArkTS卡片中设置ProgressStyleOptions,暂不支持CapsuleStyleOptions和RingStyleOptions。 | +| style8+ | [ProgressStyleOptions](#progressstyleoptions) \| [CapsuleStyleOptions10+](#capsulestyleoptions10) \| [RingStyleOptions10+](#ringstyleoptions10) \| [LinearStyleOptions10+](#linearstyleoptions10) \| [ScaleRingStyleOptions10+](#scaleringstyleoptions10) \| [EclipseStyleOptions10+](#eclipsestyleoptions10) | 定义组件的样式。
从API version 10开始支持以下类型:
- CapsuleStyleOptions:设置Capsule的样式。
- RingStyleOptions:设置Ring的样式。
- LinearStyleOptions:设置Linear的样式。
- ScaleRingStyleOptions:设置ScaleRing的样式。
- EclipseStyleOptions:设置Eclipse的样式。
- ProgressStyleOptions:仅可设置各类型进度条的基本样式。
从API version 9开始,该接口支持在ArkTS卡片中设置ProgressStyleOptions,暂不支持其它的参数类型。 | ## ProgressStyleOptions | 名称 | 参数类型 | 必填 | 描述 | | ------------ | ---------------------------- | ---- | ------------------------------------------------------------------------------------------ | -| strokeWidth | [Length](ts-types.md#length) | 否 | 设置进度条宽度(不支持百分比设置)。
默认值:4.0Vp | +| strokeWidth | [Length](ts-types.md#length) | 否 | 设置进度条宽度(不支持百分比设置)。
默认值:4.0vp | | scaleCount | number | 否 | 设置环形进度条总刻度数。
默认值:120 | -| scaleWidth | [Length](ts-types.md#length) | 否 | 设置环形进度条刻度粗细(不支持百分比设置),刻度粗细大于进度条宽度时,为系统默认粗细。
默认值:2.0Vp | +| scaleWidth | [Length](ts-types.md#length) | 否 | 设置环形进度条刻度粗细(不支持百分比设置),刻度粗细大于进度条宽度时,为系统默认粗细。
默认值:2.0vp | ## CapsuleStyleOptions10+ | 名称 | 参数类型 | 必填 | 描述 | | ------------- | ------- | ---- | -------- | | borderColor | [ResourceColor](ts-types.md#resourcecolor) | 否 | 内描边颜色。
默认值:'\#33006cde' | -| borderWidth | [Length](ts-types.md#length) | 否 | 内描边宽度(不支持百分比设置)。
默认值:1Vp | +| borderWidth | [Length](ts-types.md#length) | 否 | 内描边宽度(不支持百分比设置)。
默认值:1vp | | content | string | 否 | 文本内容,应用可自定义。 | -| font | [Font](ts-types.md#font) | 否 | 文本样式。
默认值:
- 文本大小(不支持百分比设置):12Fp
其他文本参数跟随text组件的主题值。| +| font | [Font](ts-types.md#font) | 否 | 文本样式。
默认值:
- 文本大小(不支持百分比设置):12fp
其他文本参数跟随text组件的主题值。| | fontColor | [ResourceColor](ts-types.md#resourcecolor) | 否 | 文本颜色。
默认值:'\#ff182431' | | enableScanEffect | boolean | 否 | 扫光效果的开关。
默认值:false | +| showDefaultPercentage | boolean | 否 | 显示百分比文本的开关,开启后会在进度条上显示当前进度的百分比。设置了content属性时该属性不生效。
默认值:false | ## RingStyleOptions10+ | 名称 | 参数类型 | 必填 | 描述 | | ------------- | ---------------------------- | ---- | ------------------------------------------------------------------------------------------ | -| strokeWidth | [Length](ts-types.md#length) | 否 | 设置进度条宽度(不支持百分比设置),宽度大于等于半径时,默认修改宽度至半径值的二分之一。
默认值:4Vp | +| strokeWidth | [Length](ts-types.md#length) | 否 | 设置进度条宽度(不支持百分比设置),宽度大于等于半径时,默认修改宽度至半径值的二分之一。
默认值:4.0vp | | shadow | boolean | 否 | 进度条阴影开关。
默认值:false | | status | [ProgressStatus10+](#progressstatus10枚举说明) | 否 | 进度条状态,当设置为LOADING时会开启检查更新动效,此时设置进度值不生效。
默认值: ProgressStatus.PROGRESSING | +| enableScanEffect | boolean | 否 | 进度条扫光效果的开关。
默认值: false | + +## LinearStyleOptions10+ +| 名称 | 参数类型 | 必填 | 描述 | +| ------------- | ---------------------------- | ---- | ------------------------------------------------------------------------------------------ | +| strokeWidth | [Length](ts-types.md#length) | 否 | 设置进度条宽度(不支持百分比设置)。
默认值:4.0vp | +| enableScanEffect | boolean | 否 | 进度条扫光效果的开关。
默认值: false | + +## ScaleRingStyleOptions10+ +| 名称 | 参数类型 | 必填 | 描述 | +| ------------ | ---------------------------- | ---- | ------------------------------------------------------------------------------------------ | +| strokeWidth | [Length](ts-types.md#length) | 否 | 设置进度条宽度(不支持百分比设置)。
默认值:4.0vp | +| scaleCount | number | 否 | 设置环形进度条总刻度数。
默认值:120 | +| scaleWidth | [Length](ts-types.md#length) | 否 | 设置环形进度条刻度粗细(不支持百分比设置),刻度粗细大于进度条宽度时,为系统默认粗细。
默认值:2.0vp | + +## EclipseStyleOptions10+ +暂无参数。 ## ProgressStatus10+枚举说明 | 名称 | 描述 | -- GitLab