Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
96c5de3d
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
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看板
提交
96c5de3d
编写于
4月 11, 2023
作者:
H
HelloCrease
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update docs
Signed-off-by:
N
HelloCrease
<
lian15@huawei.com
>
上级
51b06932
变更
6
显示空白变更内容
内联
并排
Showing
6 changed file
with
142 addition
and
142 deletion
+142
-142
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md
...ation-dev/reference/arkui-ts/ts-basic-components-image.md
+21
-21
zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md
...pplication-dev/reference/arkui-ts/ts-container-refresh.md
+16
-16
zh-cn/application-dev/reference/arkui-ts/ts-container-tabs.md
...n/application-dev/reference/arkui-ts/ts-container-tabs.md
+25
-25
zh-cn/application-dev/reference/arkui-ts/ts-methods-custom-dialog-box.md
...on-dev/reference/arkui-ts/ts-methods-custom-dialog-box.md
+9
-9
zh-cn/application-dev/reference/arkui-ts/ts-types.md
zh-cn/application-dev/reference/arkui-ts/ts-types.md
+53
-53
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-image-effect.md
...eference/arkui-ts/ts-universal-attributes-image-effect.md
+18
-18
未找到文件。
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md
浏览文件 @
96c5de3d
...
...
@@ -28,15 +28,15 @@ Image(src: string | PixelMap | Resource)
**参数:**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ----
-- | ------------------------------------------------------------ | ---- | --------------------
---------------------------------------- |
| src
| string
\|
[PixelMap](../apis/js-apis-image.md#pixelmap7)
\|
[
Resource
](
ts-types.md#resource类型
)
| 是 | 图片的数据源,支持本地图片和网络图片。
<br/>
当使用相对路径引用图片资源时,例如
`Image("common/test.jpg")`
,不支持跨包/跨模块调用该Image组件,建议使用
`$r`
方式来管理需全局使用的图片资源。
<br/>
\-
支持的图片格式包括png、jpg、bmp、svg和gif。
<br/>
\-
支持
`Base64`
字符串。格式
`data:image/[png\|jpeg\|bmp\|webp];base64,[base64 data]`
, 其中
`[base64 data]`
为
`Base64`
字符串数据。
<br/>
\-
支持
`datashare://`
路径前缀的字符串,用于访问通过data
ability提供的图片路径。图片加载前需要申请
[
媒体库功能相关权限
](
../../file-management/medialibrary-overview.md#申请媒体库功能相关权限
)
<br/>
\-
支持file:///data/storage路径前缀的字符串,用于读取本应用安装目录下files文件夹下的图片资源。需要保证目录包路径下的文件有可读权限。
<br/>
**说明:**
<br/>
- ArkTS卡片上支持gif图片格式动效,但仅在显示时播放一次。
<br/>
- ArkTS卡片上不支持
`http://`
等网络相关路径前缀、
`datashare://`
路径前缀以及
`file://data/storage`
路径前缀的字符串
<br/>
- ArkTS卡片上不支持
[
PixelMap
](
../apis/js-apis-image.md#pixelmap7
)
类型 |
| ----
| ---------------------------------------- | ---- |
---------------------------------------- |
| src
| string
\|
[PixelMap](../apis/js-apis-image.md#pixelmap7)
\|
[
Resource
](
ts-types.md#resource类型
)
| 是 | 图片的数据源,支持本地图片和网络图片。
<br/>
当使用相对路径引用图片资源时,例如
`Image("common/test.jpg")`
,不支持跨包/跨模块调用该Image组件,建议使用
`$r`
方式来管理需全局使用的图片资源。
<br/>
\-
支持的图片格式包括png、jpg、bmp、svg和gif。
<br/>
\-
支持
`Base64`
字符串。格式
`data:image/[png\|jpeg\|bmp\|webp];base64,[base64 data]`
, 其中
`[base64 data]`
为
`Base64`
字符串数据。
<br/>
\-
支持
`datashare://`
路径前缀的字符串,用于访问通过data
ability提供的图片路径。
<br/>
\-
支持file:///data/storage路径前缀的字符串,用于读取本应用安装目录下files文件夹下的图片资源。需要保证目录包路径下的文件有可读权限。
<br/>
**说明:**
<br/>
- ArkTS卡片上支持gif图片格式动效,但仅在显示时播放一次。
<br/>
- ArkTS卡片上不支持
`http://`
等网络相关路径前缀、
`datashare://`
路径前缀以及
`file://data/storage`
路径前缀的字符串
<br/>
- ArkTS卡片上不支持
[
PixelMap
](
../apis/js-apis-image.md#pixelmap7
)
类型 |
## 属性
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外,还支持以下属性:
| 名称 | 参数类型 | 描述 |
| ---------------------
| ------------------------------------------------------- | --------------------
---------------------------------------- |
| ---------------------
--- | ---------------------------------------- |
---------------------------------------- |
| alt | string
\|
[
Resource
](
ts-types.md#resource类型
)
| 加载时显示的占位图,支持本地图片。
<br/>
从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| objectFit |
[
ImageFit
](
ts-appendix-enums.md#imagefit
)
| 设置图片的缩放类型。
<br/>
默认值:ImageFit.Cover
<br/>
从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| objectRepeat |
[
ImageRepeat
](
ts-appendix-enums.md#imagerepeat
)
| 设置图片的重复样式。
<br/>
默认值:ImageRepeat.NoRepeat
<br/>
从API version 9开始,该接口支持在ArkTS卡片中使用。
<br/>
**说明:**
<br/>
svg类型图源不支持该属性。 |
...
...
@@ -81,7 +81,7 @@ Image(src: string | PixelMap | Resource)
除支持
[
通用事件
](
ts-universal-events-click.md
)
外,还支持以下事件:
| 名称 | 功能描述 |
| ----------------------------------------
-------------------- | --------------------
---------------------------------------- |
| ----------------------------------------
|
---------------------------------------- |
| onComplete(callback:
(event?:
{
width:
number,
height:
number,
componentWidth:
number,
<br>
componentHeight:
number,
loadingStatus:
number
})
=
>
void) | 图片成功加载时触发该回调,返回成功加载的图片尺寸。
<br>
- width:图片的宽,单位为像素。
<br/>
- height:图片的高,单位为像素。
<br/>
- componentWidth:组件的宽,单位为像素。
<br/>
- componentHeight:组件的高,单位为像素。
<br/>
- loadingStatus:图片加载成功的状态。
<br/>
从API version 9开始,该接口支持在ArkTS卡片中使用。
<br/>
**说明:**
<br/>
loadingStatus返回的状态值为0时,代表图片加载失败;返回的状态值为1时,代表图片加载成功。 |
| onError(callback:
(event?:
{
componentWidth:
number,
componentHeight:
number
, message
<sup>
9+
</sup>
: string })
=
>
void) | 图片加载出现异常时触发该回调。
<br>
- componentWidth:组件的宽,单位为像素。
<br/>
- componentHeight:组件的高,单位为像素。
<br/>
从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| onFinish(event:
()
=
>
void) | 当加载的源文件为带动效的svg图片时,当svg动效播放完成时会触发这个回调,如果动效为无限循环动效,则不会触发这个回调。
<br/>
从API version 9开始,该接口支持在ArkTS卡片中使用。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md
浏览文件 @
96c5de3d
...
...
@@ -17,8 +17,8 @@ Refresh\(value: \{ refreshing: boolean, offset?: number | string , fr
**参数:**
| 参数 | 参数名 | 必填 | 参数描述 |
| --------
| -------- | -------- |
-------- |
| refreshing | boolean
| 是 | 当前组件是否正在刷新。
<br/>
该参数支持
[
$$
](
../../quick-start/arkts-restrictions-and-extensions.md#变量的双向绑定
)
双向绑定变量。 |
| --------
-- | -------------------------- | ---- | --------------------------------
-------- |
| refreshing | boolean
| 是 | 当前组件是否正在刷新。
<br/>
该参数支持
[
$$
](
../../quick-start/arkts-two-way-sync.md
)
双向绑定变量。 |
| offset | string
\|
number | 否 | 下拉起点距离组件顶部的距离。
<br/>
默认值:16,单位vp
<br/>
**说明:**
<br/>
不支持百分比,不支持负数 |
| friction | number
\|
string | 否 | 下拉摩擦系数,取值范围为0到100。
<br/>
默认值:62
<br/>
-
0表示下拉刷新容器不跟随手势下拉而下拉。
<br/>
-
100表示下拉刷新容器紧紧跟随手势下拉而下拉。
<br/>
-
数值越大,下拉刷新容器跟随手势下拉的反应越灵敏。 |
...
...
@@ -32,14 +32,14 @@ Refresh\(value: \{ refreshing: boolean, offset?: number | string , fr
| 名称 | 描述 |
| --------
|
-------- |
| onStateChange(callback: (state:
[
RefreshStatus
](
#refreshstatus枚举说明
)
) => void)| 当前刷新状态变更时,触发回调。
<br/>
-
state:刷新状态。 |
| onRefreshing(callback: () => void)
| 进入刷新状态时触发回调。
|
| --------
-------------------------------- | ------------------------------
-------- |
| onStateChange(callback: (state:
[
RefreshStatus
](
#refreshstatus枚举说明
)
) => void)
| 当前刷新状态变更时,触发回调。
<br/>
-
state:刷新状态。 |
| onRefreshing(callback: () => void)
| 进入刷新状态时触发回调。
|
## RefreshStatus枚举说明
| 名称 | 描述 |
| -------- | -------- |
| -------- | --------
------------
|
| Inactive | 默认未下拉状态。 |
| Drag | 下拉中,下拉距离小于刷新距离。 |
| OverDrag | 下拉中,下拉距离超过刷新距离。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-tabs.md
浏览文件 @
96c5de3d
...
...
@@ -19,7 +19,7 @@ Tabs(value?: {barPosition?: BarPosition, index?: number, controller?: [TabsContr
**参数:**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| --------
| -------- | -------- |
-------- |
| --------
--- | --------------------------------- | ---- | --------------------------------
-------- |
| barPosition | BarPosition | 否 | 设置Tabs的页签位置。
<br/>
默认值:BarPosition.Start |
| index | number | 否 | 设置初始页签索引。
<br/>
默认值:0
<br/>
**说明:**
<br/>
设置为小于0的值时按默认值显示。
<br/>
可选值为[0, TabContent子节点数量-1]。
<br/>
设置不同值时,默认生效切换动效,可以设置animationDuration为0关闭动画。 |
| controller |
[
TabsController
](
#tabscontroller
)
| 否 | 设置Tabs控制器。 |
...
...
@@ -27,7 +27,7 @@ Tabs(value?: {barPosition?: BarPosition, index?: number, controller?: [TabsContr
## BarPosition枚举说明
| 名称 | 描述 |
| -----
--- |
-------- |
| -----
| --------------------------------
-------- |
| Start | vertical属性方法设置为true时,页签位于容器左侧;vertical属性方法设置为false时,页签位于容器顶部。 |
| End | vertical属性方法设置为true时,页签位于容器右侧;vertical属性方法设置为false时,页签位于容器底部。 |
...
...
@@ -37,7 +37,7 @@ Tabs(value?: {barPosition?: BarPosition, index?: number, controller?: [TabsContr
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外,还支持以下属性:
| 名称 | 参数类型 | 描述 |
| --------
| -------- |
-------- |
| --------
--------- | --------------------------------------- | --------------------------------
-------- |
| vertical | boolean | 设置为false是为横向Tabs,设置为true时为纵向Tabs。
<br/>
默认值:false |
| scrollable | boolean | 设置为true时可以通过滑动页面进行页面切换,为false时不可滑动切换页面。
<br/>
默认值:true |
| barMode | BarMode | TabBar布局模式,具体描述见BarMode枚举说明。
<br/>
默认值:BarMode.Fixed |
...
...
@@ -48,7 +48,7 @@ Tabs(value?: {barPosition?: BarPosition, index?: number, controller?: [TabsContr
## BarMode枚举说明
| 名称 | 描述 |
| --------
|
-------- |
| --------
-- | --------------------------------
-------- |
| Scrollable | 每一个TabBar均使用实际布局宽度,超过总长度(横向Tabs的barWidth,纵向Tabs的barHeight)后可滑动。 |
| Fixed | 所有TabBar平均分配barWidth宽度(纵向时平均分配barHeight高度)。 |
...
...
@@ -57,8 +57,8 @@ Tabs(value?: {barPosition?: BarPosition, index?: number, controller?: [TabsContr
除支持
[
通用事件
](
ts-universal-events-click.md
)
外,还支持以下事件:
| 名称 | 功能描述 |
| --------
|
-------- |
| onChange(event:
(index:
number)
=
>
void) | Tab页签切换后触发的事件。
<br>
-
index:当前显示的index索引,索引从0开始计算。
<br/>
触发该事件的条件:
<br/>
1、TabContent支持滑动时,组件触发滑动时触发。
<br/>
2、通过
[
控制器
](
#tabscontroller
)
API接口调用。
<br/>
3、通过
[
状态变量
](
../../quick-start/arkts-state
-mgmt-page-level
.md
)
构造的属性值进行修改。
<br/>
4、通过页签处点击触发。 |
| --------
-------------------------------- | --------------------------------
-------- |
| onChange(event:
(index:
number)
=
>
void) | Tab页签切换后触发的事件。
<br>
-
index:当前显示的index索引,索引从0开始计算。
<br/>
触发该事件的条件:
<br/>
1、TabContent支持滑动时,组件触发滑动时触发。
<br/>
2、通过
[
控制器
](
#tabscontroller
)
API接口调用。
<br/>
3、通过
[
状态变量
](
../../quick-start/arkts-state.md
)
构造的属性值进行修改。
<br/>
4、通过页签处点击触发。 |
## TabsController
...
...
@@ -79,7 +79,7 @@ changeIndex(value: number): void
**参数:**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -----
--- | -------- | -------- |
-------- |
| -----
| ------ | ---- | --------------------------------
-------- |
| value | number | 是 | 页签在Tabs里的索引值,索引值从0开始。
<br/>
**说明:**
<br/>
设置小于0或大于最大数量的值时,该事件失效。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-methods-custom-dialog-box.md
浏览文件 @
96c5de3d
...
...
@@ -17,14 +17,14 @@ CustomDialogController(value:{builder: CustomDialog, cancel?: () => void, aut
**参数:**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ---------------------- | ---------------------------------------- | ----
--------------------- |
---------------------- |
| builder |
[
CustomDialog
](
../../quick-start/arkts-dynamic-ui-elememt-building.md#customdialog
)
| 是 | 自定义弹窗内容构造器。
|
| ---------------------- | ---------------------------------------- | ----
| ------------------
---------------------- |
| builder |
CustomDialog | 是 | 自定义弹窗内容构造器。
|
| cancel | ()
=
>
void | 否 | 点击遮障层退出时的回调。 |
| autoCancel | boolean | 否 | 是否允许点击遮障层退出。
<br>
默认值:true |
| alignment |
[
DialogAlignment
](
ts-methods-alert-dialog-box.md#dialogalignment枚举说明
)
| 否 | 弹窗在竖直方向上的对齐方式。
<br>
默认值:DialogAlignment.Default |
| offset |
[
Offset
](
ts-types.md#offset
)
| 否 | 弹窗相对alignment所在位置的偏移量。 |
| customStyle | boolean | 否 | 弹窗容器样式是否自定义。
<br>
默认值:false,弹窗容器的宽度根据栅格系统自适应,不跟随子节点;高度自适应子节点,最大为窗口高度的90%;圆角为24vp。 |
| gridCount
<sup>
8+
</sup>
| number | 否
| 弹窗宽度占
[
栅格宽度
](
../../ui/ui-ts-layout-grid-container-new
.md
)
的个数。
<br>
默认值为4,异常值按默认值处理,最大栅格数为系统最大栅格数。 |
| gridCount
<sup>
8+
</sup>
| number | 否
| 弹窗宽度占
[
栅格宽度
](
../../ui/arkts-layout-development-grid-layout
.md
)
的个数。
<br>
默认值为4,异常值按默认值处理,最大栅格数为系统最大栅格数。 |
## CustomDialogController
...
...
zh-cn/application-dev/reference/arkui-ts/ts-types.md
浏览文件 @
96c5de3d
...
...
@@ -25,7 +25,7 @@
长度类型,用于描述尺寸单位。
| 类型 | 说明 |
| -------- | -------------------------------------- |
| --------
-------------
| -------------------------------------- |
| string | 需要显式指定像素单位,如'10px',也可设置百分比字符串,如'100%'。 |
| number | 默认单位vp。 |
|
[
Resource
](
#resource
)
| 资源引用类型,引入系统资源或者应用资源中的尺寸。 |
...
...
@@ -35,7 +35,7 @@
字符串类型,用于描述字符串入参可以使用的类型。
| 类型 | 说明 |
| --------
| ---
------------------------- |
| --------
------------- |
------------------------- |
| string | 字符串类型。 |
|
[
Resource
](
#resource
)
| 资源引用类型,引入系统资源或者应用资源中的字符串。 |
...
...
@@ -44,7 +44,7 @@
内边距类型,用于描述组件不同方向的内边距。
| 名称 | 类型 | 必填 | 说明 |
| ------ | ------
| ---- |
--------------- |
| ------ | ------
----------- | ---- | -----
--------------- |
| top |
[
Length
](
#length
)
| 否 | 上内边距,组件内元素距组件顶部的尺寸。 |
| right |
[
Length
](
#length
)
| 否 | 右内边距,组件内元素距组件右边界的尺寸。 |
| bottom |
[
Length
](
#length
)
| 否 | 下内边距,组件内元素距组件底部的尺寸。 |
...
...
@@ -55,7 +55,7 @@
外边距类型,用于描述组件不同方向的外边距。
| 名称 | 类型 | 必填 | 说明 |
| ------ | ------
| ---- |
--------------- |
| ------ | ------
----------- | ---- | -----
--------------- |
| top |
[
Length
](
#length
)
| 否 | 上外边距,组件顶部距组件外元素的尺寸。 |
| right |
[
Length
](
#length
)
| 否 | 右外边距,组件右边界距组件外元素的尺寸。 |
| bottom |
[
Length
](
#length
)
| 否 | 下外边距,组件底部距组件外元素的尺寸。 |
...
...
@@ -66,7 +66,7 @@
边框宽度类型,用于描述组件边框不同方向的宽度。
| 名称 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------- |
| ------ | ------
-----------
| ---- | -------- |
| top |
[
Length
](
#length
)
| 否 | 组件上边框宽度。 |
| right |
[
Length
](
#length
)
| 否 | 组件右边框宽度。 |
| bottom |
[
Length
](
#length
)
| 否 | 组件下边框宽度。 |
...
...
@@ -77,7 +77,7 @@
圆角类型,用于描述组件边框圆角半径。
| 名称 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ---------- |
| ----------- | ------
-----------
| ---- | ---------- |
| topLeft |
[
Length
](
#length
)
| 否 | 组件左上角圆角半径。 |
| topRight |
[
Length
](
#length
)
| 否 | 组件右上角圆角半径。 |
| bottomLeft |
[
Length
](
#length
)
| 否 | 组件左下角圆角半径。 |
...
...
@@ -88,7 +88,7 @@
边框颜色,用于描述组件边框四条边的颜色。
| 名称 | 类型 | 必填 | 说明 |
| ------ | ------------- | ---- | -------- |
| ------ | -------------
------------------
| ---- | -------- |
| top |
[
ResourceColor
](
#resourcecolor
)
| 否 | 组件上边框颜色。 |
| right |
[
ResourceColor
](
#resourcecolor
)
| 否 | 组件右边框颜色。 |
| bottom |
[
ResourceColor
](
#resourcecolor
)
| 否 | 组件下边框颜色。 |
...
...
@@ -99,7 +99,7 @@
边框样式,用于描述组件边框四条边的样式。
| 名称 | 类型 | 必填 | 说明 |
| ------ | ----------- | ---- | -------- |
| ------ | -----------
-----------------------------
| ---- | -------- |
| top |
[
BorderStyle
](
ts-appendix-enums.md#borderstyle
)
| 否 | 组件上边框样式。 |
| right |
[
BorderStyle
](
ts-appendix-enums.md#borderstyle
)
| 否 | 组件右边框样式。 |
| bottom |
[
BorderStyle
](
ts-appendix-enums.md#borderstyle
)
| 否 | 组件下边框样式。 |
...
...
@@ -111,7 +111,7 @@
相对布局完成位置坐标偏移量。
| 名称 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------- |
| ---- | ------
-----------
| ---- | -------- |
| dx |
[
Length
](
#length
)
| 是 | 水平方向偏移量。 |
| dy |
[
Length
](
#length
)
| 是 | 竖直方向偏移量。 |
...
...
@@ -120,7 +120,7 @@
颜色类型,用于描述资源颜色类型。
| 类型 | 说明 |
| -----------------------------------
----- | ----------------------
--------------------------- |
| -----------------------------------
|
--------------------------- |
|
[
Color
](
ts-appendix-enums.md#color
)
| 颜色枚举值。 |
| number | HEX格式颜色,支持rgb。 |
| string | rgb或者rgba格式颜色。 |
...
...
@@ -131,7 +131,7 @@
长度约束,用于对组件最大、最小长度做限制。
| 名称 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ------- |
| --------- | ------
-----------
| ---- | ------- |
| minLength |
[
Length
](
#length
)
| 是 | 组件最小长度。 |
| maxLength |
[
Length
](
#length
)
| 是 | 组件最大长度。 |
...
...
@@ -141,7 +141,7 @@
设置文本样式。
| 名称 | 类型 | 必填 | 说明 |
| ------ | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| ------ | ----------------------------------------
| ---- |
---------------------------------------- |
| size |
[
Length
](
#length
)
| 否 | 设置文本尺寸,Length为number类型时,使用fp单位。不支持设置百分比字符串。 |
| weight |
[
FontWeight
](
ts-appendix-enums.md#fontweight
)
\|
number
\|
string | 否 | 设置文本的字体粗细,number类型取值[100, 900],取值间隔为100,默认为400,取值越大,字体越粗。 |
| family | string
\|
[
Resource
](
#resource
)
| 否 | 设置文本的字体列表。使用多个字体,使用','进行分割,优先级按顺序生效。例如:'Arial, sans-serif'。当前只支持'sans-serif'字体。 |
...
...
@@ -163,7 +163,7 @@
位置类型,用于表示一个坐标点。
| 名称 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------------------------- |
| ---- | ------
-----------
| ---- | --------------------------- |
| x |
[
Length
](
#length
)
| 否 | x轴坐标,作为返回值时,类型为number,单位vp。 |
| y |
[
Length
](
#length
)
| 否 | y轴坐标,作为返回值时,类型为number,单位vp。 |
...
...
@@ -172,7 +172,7 @@
设置约束尺寸,组件布局时,进行尺寸范围限制。
| 名称 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ------- |
| --------- | ------
-----------
| ---- | ------- |
| minWidth |
[
Length
](
#length
)
| 否 | 元素最小宽度。 |
| maxWidth |
[
Length
](
#length
)
| 否 | 元素最大宽度。 |
| minHeight |
[
Length
](
#length
)
| 否 | 元素最小高度。 |
...
...
@@ -183,7 +183,7 @@
设置宽高尺寸。
| 名称 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ----- |
| ------ | ------
-----------
| ---- | ----- |
| width |
[
Length
](
#length
)
| 否 | 元素宽度。 |
| height |
[
Length
](
#length
)
| 否 | 元素高度。 |
...
...
@@ -214,5 +214,5 @@
| 名称 | 类型定义 | 描述 |
| ------------- | ---------------------- | ---------------------------------------- |
| CustomBuilder | ()
=
>
any | 该方法类型必须使用@Builder装饰器修饰。具体用法见
[
@Builder
](
../../quick-start/arkts-
dynamic-ui-elememt-building.md#builder
)
。 |
| CustomBuilder | ()
=
>
any | 该方法类型必须使用@Builder装饰器修饰。具体用法见
[
@Builder
](
../../quick-start/arkts-
builder.md
)
。 |
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-image-effect.md
浏览文件 @
96c5de3d
...
...
@@ -11,10 +11,10 @@
| 名称 | 参数类型 | 默认值 | 描述 |
| ----------------------------- | ----------------------------------------
-------------------- | ------ | --------------------
---------------------------------------- |
| ----------------------------- | ----------------------------------------
| ------ |
---------------------------------------- |
| blur | number | - | 为当前组件添加内容模糊效果,入参为模糊半径,模糊半径越大越模糊,为0时不模糊。
<br/>
取值范围:
[
0, +∞)<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| backdropBlur | number | - | 为当前组件添加背景模糊效果,入参为模糊半径,模糊半径越大越模糊,为0时不模糊。<br/>取值范围:[0, +∞)<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| shadow |
[ShadowOptions
](
#shadowoptions对象说明
)
| - | 为当前组件添加阴影效果。
<br/>
入参类型为ShadowOptions时,可以指定模糊半径、阴影的颜色、X轴和Y轴的偏移量。
<br/>
从API version 9开始,该接口支持在ArkTS卡片中使用。
<br/>
**说明:**
<br/>
ArkTS卡片上不支持参数为
[
ShadowStyle
](
#shadowstyle10枚举说明
)
类型。 |
| shadow |
{<br/>radius: number \| [Resource
](
ts-types.md#resource
)
,
<br/>
color?:
[
Color
](
ts-appendix-enums.md#color
)
\|
string
\|
[
Resource
](
ts-types.md#resource
)
,
<br/>
offsetX?:
number
\|
[
Resource
](
ts-types.md#resource
)
,
<br/>
offsetY?:
number
\|
[
Resource
](
ts-types.md#resource
)
<br/>
}
| - | 为当前组件添加阴影效果。
<br/>
入参类型为ShadowOptions时,可以指定模糊半径、阴影的颜色、X轴和Y轴的偏移量。
<br/>
从API version 9开始,该接口支持在ArkTS卡片中使用。
<br/>
**说明:**
<br/>
ArkTS卡片上不支持参数为
[
ShadowStyle
](
#shadowstyle10枚举说明
)
类型。 |
| grayscale | number | 0.0 | 为当前组件添加灰度效果。值定义为灰度转换的比例,入参1.0则完全转为灰度图像,入参则0.0图像无变化,入参在0.0和1.0之间时,效果呈线性变化。(百分比)
<br/>
取值范围:[0, 1]
<br/>
**说明:**
<br/>
设置小于0的值时,按值为0处理,设置大于1的值时,按值为1处理。
<br/>
从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| brightness | number | 1.0 | 为当前组件添加高光效果,入参为高光比例,值为1时没有效果,小于1时亮度变暗,0为全黑,大于1时亮度增加,数值越大亮度越大。
<br/>
取值范围:[0, +∞)
<br/>
**说明:**
<br/>
设置小于0的值时,按值为0处理。
<br/>
从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| saturate | number | 1.0 | 为当前组件添加饱和度效果,饱和度为颜色中的含色成分和消色成分(灰)的比例,入参为1时,显示原图像,大于1时含色成分越大,饱和度越大,小于1时消色成分越大,饱和度越小。(百分比)
<br/>
取值范围:[0, +∞)
<br/>
**说明:**
<br/>
设置小于0的值时,按值为0处理。
<br/>
从API version 9开始,该接口支持在ArkTS卡片中使用。 |
...
...
@@ -31,7 +31,7 @@
从API version 9开始,该接口支持在ArkTS卡片中使用。
| 名称 | 类型 | 必填 | 说明 |
| ------
| ------ | ---- |
--------------- |
| ------
- | ---------------------------------------- | ---- | -------------------------
--------------- |
| radius | number
\|
[
Resource
](
ts-types.md#resource
)
| 是 | 阴影模糊半径。
<br/>
取值范围:
[
0, +∞)<br/>**说明:** <br/>设置小于0的值时,按值为0处理。 |
| color | [Color
](
ts-appendix-enums.md#color
)
\|
string
\|
[
Resource
](
ts-types.md#resource
)
| 否 | 阴影的颜色。
<br/>
默认为黑色。 |
| offsetX | number
\|
[
Resource
](
ts-types.md#resource
)
| 否 | 阴影的X轴偏移量。
<br/>
默认为0。 |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录