Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
5a2d2aa0
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看板
提交
5a2d2aa0
编写于
9月 01, 2022
作者:
G
gmy
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update docs
Signed-off-by:
N
gmy
<
guanmingyue@h-partners.com
>
上级
ab123bf7
变更
22
展开全部
隐藏空白更改
内联
并排
Showing
22 changed file
with
805 addition
and
779 deletion
+805
-779
zh-cn/application-dev/reference/arkui-js/js-components-basic-qrcode.md
...tion-dev/reference/arkui-js/js-components-basic-qrcode.md
+3
-0
zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001118642902.png
...ference/arkui-ts/figures/zh-cn_image_0000001118642902.png
+0
-0
zh-cn/application-dev/reference/arkui-ts/ts-animatorproperty.md
...application-dev/reference/arkui-ts/ts-animatorproperty.md
+17
-17
zh-cn/application-dev/reference/arkui-ts/ts-appendix-enums.md
...n/application-dev/reference/arkui-ts/ts-appendix-enums.md
+6
-4
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-blank.md
...ation-dev/reference/arkui-ts/ts-basic-components-blank.md
+12
-19
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkbox.md
...on-dev/reference/arkui-ts/ts-basic-components-checkbox.md
+3
-3
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-divider.md
...ion-dev/reference/arkui-ts/ts-basic-components-divider.md
+11
-15
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-gauge.md
...ation-dev/reference/arkui-ts/ts-basic-components-gauge.md
+22
-25
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md
...ation-dev/reference/arkui-ts/ts-basic-components-image.md
+20
-18
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md
...-dev/reference/arkui-ts/ts-basic-components-navigation.md
+42
-43
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-patternlock.md
...dev/reference/arkui-ts/ts-basic-components-patternlock.md
+16
-18
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-plugincomponent.md
...reference/arkui-ts/ts-basic-components-plugincomponent.md
+76
-73
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md
...on-dev/reference/arkui-ts/ts-basic-components-progress.md
+24
-27
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md
...tion-dev/reference/arkui-ts/ts-basic-components-qrcode.md
+11
-14
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-radio.md
...ation-dev/reference/arkui-ts/ts-basic-components-radio.md
+15
-17
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md
...tion-dev/reference/arkui-ts/ts-basic-components-search.md
+23
-27
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md
...n-dev/reference/arkui-ts/ts-basic-components-textinput.md
+53
-51
zh-cn/application-dev/reference/arkui-ts/ts-canvasrenderingcontext2d.md
...ion-dev/reference/arkui-ts/ts-canvasrenderingcontext2d.md
+92
-92
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-ellipse.md
...n-dev/reference/arkui-ts/ts-drawing-components-ellipse.md
+16
-24
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-path.md
...tion-dev/reference/arkui-ts/ts-drawing-components-path.md
+13
-19
zh-cn/application-dev/reference/arkui-ts/ts-matrix-transformation.md
...cation-dev/reference/arkui-ts/ts-matrix-transformation.md
+325
-264
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-z-order.md
...dev/reference/arkui-ts/ts-universal-attributes-z-order.md
+5
-9
未找到文件。
zh-cn/application-dev/reference/arkui-js/js-components-basic-qrcode.md
浏览文件 @
5a2d2aa0
...
@@ -58,6 +58,8 @@
...
@@ -58,6 +58,8 @@
<div
class=
"container"
>
<div
class=
"container"
>
<qrcode
value=
"{{qr_value}}"
type=
"{{qr_type}}"
<qrcode
value=
"{{qr_value}}"
type=
"{{qr_type}}"
style=
"color: {{qr_col}};background-color: {{qr_bcol}};width: {{qr_size}};height: {{qr_size}};margin-bottom: 70px;"
></qrcode>
style=
"color: {{qr_col}};background-color: {{qr_bcol}};width: {{qr_size}};height: {{qr_size}};margin-bottom: 70px;"
></qrcode>
<text
class=
"txt"
>
Value
</text>
<input
onChange=
"setValue"
>
123
</input>
<text
class=
"txt"
>
Type
</text>
<text
class=
"txt"
>
Type
</text>
<switch
showtext=
"true"
checked=
"true"
texton=
"rect"
textoff=
"circle"
onchange=
"settype"
></switch>
<switch
showtext=
"true"
checked=
"true"
texton=
"rect"
textoff=
"circle"
onchange=
"settype"
></switch>
<text
class=
"txt"
>
Color
</text>
<text
class=
"txt"
>
Color
</text>
...
@@ -94,6 +96,7 @@ select{
...
@@ -94,6 +96,7 @@ select{
/* index.js */
/* index.js */
export
default
{
export
default
{
data
:
{
data
:
{
qr_value
:
''
,
qr_type
:
'
rect
'
,
qr_type
:
'
rect
'
,
qr_size
:
'
300px
'
,
qr_size
:
'
300px
'
,
qr_col
:
'
#87ceeb
'
,
qr_col
:
'
#87ceeb
'
,
...
...
zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001118642902.png
0 → 100644
浏览文件 @
5a2d2aa0
45.1 KB
zh-cn/application-dev/reference/arkui-ts/ts-animatorproperty.md
浏览文件 @
5a2d2aa0
# 属性动画
# 属性动画
组件的某些通用属性变化时,可以通过属性动画实现渐变效果,提升用户体验。支持的属性包括width、height、backgroundColor、opacity、scale、rotate、translate等。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
组件的通用属性发生变化时,可以创建属性动画进行渐变,提升用户体验。
animation(value: {duration?: number, tempo?: number, curve?: string | Curve | ICurve, delay?:number, iterations: number, playMode?: PlayMode, onFinish?: () => void})
| 接口名称 | 功能描述 |
| ------------------------------ | ------------------------------------------------------------ |
| animation(value: AnimateParam) | 为组件添加动画属性,控制调用此属性的组件从一种状态到另一种状态的过渡效果。 |
## AnimateParam对象说明
为组件添加属性动画,实现组件属性状态变化时的过渡动画效果。
-
属性
**参数:**
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 必填 | 描述 |
| ---------- | ---------------------------------------- | --------------- | ----------------------- |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| duration | number | 1000 | 单位为毫秒,默认动画时长为1000毫秒。 |
| duration | number | 否 | 设置动画时长。单位为毫秒,默认动画时长为1000毫秒。
<br/>
默认值:1000 |
| curve |
[
Curve
](
ts-appendix-enums.md#curve
)
| Curve.Linear | 默认曲线为线性。 |
| tempo | number | 否 | 动画播放速度。数值越大,动画播放速度越快,数值越小,播放速度越慢
<br/>
值为0时,表示不存在动画。
<br/>
默认值:1 |
| delay | number | 0 | 单位为毫秒,默认不延时播放。 |
| curve | string
\|
[Curve](ts-appendix-enums.md#curve)
\|
ICurve
<sup>
9+
</sup>
| 否 | 设置动画曲线。默认曲线为线性。
<br/>
默认值:Curve.Linear |
| iterations | number | 1 | 默认播放一次,设置为-1时表示无限次播放。 |
| delay | number | 否 | 设置动画延迟执行的时长。单位为毫秒,默认不延时播放。
<br/>
默认值:0 |
| playMode |
[
PlayMode
](
ts-appendix-enums.md#playmode
)
| PlayMode.Normal | 设置动画播放模式,默认播放完成后重头开始播放。 |
| iterations | number | 否 | 设置播放次数。默认播放一次,设置为-1时表示无限次播放。
<br/>
默认值:1 |
| playMode |
[
PlayMode
](
ts-appendix-enums.md#playmode
)
| 否 | 设置动画播放模式,默认播放完成后重头开始播放。
<br/>
默认值:PlayMode.Normal |
| onFinish | () => void | 否 | 状态回调,动画播放完成时触发。 |
## 示例
## 示例
...
@@ -30,9 +30,9 @@
...
@@ -30,9 +30,9 @@
@
Entry
@
Entry
@
Component
@
Component
struct
AttrAnimationExample
{
struct
AttrAnimationExample
{
@
State
widthSize
:
number
=
200
@
State
widthSize
:
number
=
200
;
@
State
heightSize
:
number
=
100
@
State
heightSize
:
number
=
100
;
@
State
flag
:
boolean
=
true
@
State
flag
:
boolean
=
true
;
build
()
{
build
()
{
Column
()
{
Column
()
{
...
...
zh-cn/application-dev/reference/arkui-ts/ts-appendix-enums.md
浏览文件 @
5a2d2aa0
...
@@ -100,10 +100,12 @@
...
@@ -100,10 +100,12 @@
## FillMode
## FillMode
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------------------------------- |
| --------- | ------------------------------------------------------------ |
| None | 播放完成后恢复初始状态。 |
| None | 动画未执行时不会将任何样式应用于目标,动画播放完成之后恢复初始默认状态。 |
| Forwards | 播放完成后保持动画结束时的状态。 |
| Forwards | 目标将保留动画执行期间最后一个关键帧的状态。 |
| Backwards | 动画将在应用于目标时立即应用第一个关键帧中定义的值,并在delay期间保留此值。第一个关键帧取决于playMode,playMode为Normal或Alternate时为from的状态,playMode为Reverse或AlternateReverse时为to的状态。 |
| Both | 动画将遵循Forwards和Backwards的规则,从而在两个方向上扩展动画属性。 |
## PlayMode
## PlayMode
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-blank.md
浏览文件 @
5a2d2aa0
# Blank
# Blank
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
空白填充组件,在容器主轴方向上,空白填充组件具有自动填充容器空余部分的能力。仅当父组件为Row/Column时生效。
空白填充组件,在容器主轴方向上,空白填充组件具有自动填充容器空余部分的能力。仅当父组件为Row/Column时生效。
> **说明:**
## 权限列表
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
无
## 子组件
## 子组件
...
@@ -19,23 +14,21 @@
...
@@ -19,23 +14,21 @@
## 接口
## 接口
Blank(min?:
Length
)
Blank(min?:
number
|
string
)
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| min |
[
Length
](
../../ui/ts-types.md
)
| 否 | 0 | 空白填充组件在容器主轴上的最小大小。 |
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| min | number
\|
string | 否 | 空白填充组件在容器主轴上的最小大小。
<br/>
默认值:0 |
## 属性
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外,还支持以下属性:
| -------- | -------- | -------- | -------- |
| color |
[
ResourceColor
](
../../ui/ts-types.md
)
| 0xffffff | 设置空白填充的填充颜色。 |
> **说明:**
| 名称 | 参数类型 | 描述 |
>
| -------- | -------- | -------- |
> - 不支持通用属性方法。
| color |
[
ResourceColor
](
../../ui/ts-types.md
)
| 设置空白填充的填充颜色。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkbox.md
浏览文件 @
5a2d2aa0
...
@@ -35,10 +35,10 @@ Checkbox( name?: string, group?: string )
...
@@ -35,10 +35,10 @@ Checkbox( name?: string, group?: string )
## 事件
## 事件
| 名称 | 功能描述 |
| 名称 | 功能描述 |
| ----------| -------- |
| ----------| -------- |
|onChange(callback: (value: boolean) => void) | 当选中状态发生变化时,触发该回调。
<br>
- value为true时,表示已选中。
<br>
- value为false时,表示未选中。 |
|onChange(callback: (value: boolean) => void) | 当选中状态发生变化时,触发该回调。
<br>
- value为true时,表示已选中。
<br>
- value为false时,表示未选中。 |
## 示例
## 示例
```
ts
```
ts
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-divider.md
浏览文件 @
5a2d2aa0
# Divider
# Divider
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
提供分隔器组件,分隔不同内容块/内容元素。
提供分隔器组件,分隔不同内容块/内容元素。
> **说明:**
## 权限列表
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
无
## 子组件
## 子组件
...
@@ -21,15 +16,16 @@
...
@@ -21,15 +16,16 @@
Divider()
Divider()
## 属性
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外,还支持以下属性:
| -------- | -------- | -------- | -------- |
| vertical | boolean | false | 使用水平分割线还是垂直分割线。false:水平分割线;true:垂直分割线。 |
| 名称 | 参数类型 | 描述 |
| color |
[
ResourceColor
](
../../ui/ts-types.md
)
| - | 分割线颜色。 |
| -------- | -------- | -------- |
| strokeWidth |
[
Length
](
../../ui/ts-types.md
)
| 1 | 分割线宽度。 |
| vertical | boolean | 使用水平分割线还是垂直分割线。false:水平分割线;true:垂直分割线。
<br/>
默认值:false |
| lineCap |
[
LineCapStyle
](
ts-appendix-enums.md#linecapstyle
)
| LineCapStyle.Butt | 分割线的端点样式。 |
| color |
[
ResourceColor
](
../../ui/ts-types.md
)
| 分割线颜色。 |
| strokeWidth | number
\|
string | 分割线宽度。
<br/>
默认值:1 |
| lineCap |
[
LineCapStyle
](
ts-appendix-enums.md#linecapstyle
)
| 分割线的端点样式。
<br/>
默认值:LineCapStyle.Butt |
## 事件
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-gauge.md
浏览文件 @
5a2d2aa0
# Gauge
# Gauge
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
数据量规图表组件,用于将数据展示为环形图表。
数据量规图表组件,用于将数据展示为环形图表。
## 权限列表
> **说明:**
>
无
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 子组件
## 子组件
...
@@ -22,36 +17,38 @@
...
@@ -22,36 +17,38 @@
Gauge(options:{value: number, min?: number, max?: number})
Gauge(options:{value: number, min?: number, max?: number})
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| value | number | 是 | - | 当前数据值。 |
| min | number | 否 | 0 | 当前数据段最小值。 |
| max | number | 否 | 100 | 当前数据段最大值。 |
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| value | number | 是 | 当前数据值。 |
| min | number | 否 | 当前数据段最小值。
<br/>
默认值:0 |
| max | number | 否 | 当前数据段最大值。
<br/>
默认值:100 |
## 属性
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外,还支持以下属性:
| -------- | -------- | -------- | -------- |
| value | number | 0 | 设置当前数据图表的值。 |
| 名称 | 参数类型 | 描述 |
| startAngle | number | -150 | 设置起始角度位置,时钟0点为0度,顺时针方向为正角度。 |
| -------- | -------- | -------- |
| endAngle | number | 150 | 设置终止角度位置,时钟0点为0度,顺时针方向为正角度。 |
| value | number | 设置当前数据图表的值。
<br/>
默认值:0 |
| colors | Array
<
ColorStop
>
| - | 设置图表的颜色,支持分段颜色设置。 |
| startAngle | number | 设置起始角度位置,时钟0点为0度,顺时针方向为正角度。
<br/>
默认值:-150 |
| strokeWidth | Length | - | 设置环形图表的环形厚度。 |
| endAngle | number | 设置终止角度位置,时钟0点为0度,顺时针方向为正角度。
<br/>
默认值:150 |
| colors | Array
<
ColorStop
>
| 设置图表的颜色,支持分段颜色设置。 |
| strokeWidth | Length | 设置环形图表的环形厚度。 |
## ColorStop
## ColorStop
颜色断点类型,用于描述渐进色颜色断点。
颜色断点类型,用于描述渐进色颜色断点。
| 名称 | 类型定义 | 描述 |
| 名称 | 类型定义
| 描述 |
| --------- | -------------------- | ------------------------------------------------------------ |
| --------- | --------------------
----------------------------------------
| ------------------------------------------------------------ |
| ColorStop |
[
ResourceColor
](
../../ui/ts-types.md#resourcecolor8
)
,
number] | 描述渐进色颜色断点类型,第一个参数为颜色值,第二个参数为0~1之间的比例值。 |
| ColorStop |
[
[
ResourceColor
](
../../ui/ts-types.md#resourcecolor8
)
,
number] | 描述渐进色颜色断点类型,第一个参数为颜色值,第二个参数为0~1之间的比例值。 |
## 示例
## 示例
```
ts
```
ts
// xxx.ets
// xxx.ets
@
Entry
@
Entry
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md
浏览文件 @
5a2d2aa0
...
@@ -3,6 +3,7 @@
...
@@ -3,6 +3,7 @@
图片组件,支持本地图片和网络图片的渲染展示。
图片组件,支持本地图片和网络图片的渲染展示。
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -34,31 +35,32 @@ Image(src: string | PixelMap | Resource)
...
@@ -34,31 +35,32 @@ Image(src: string | PixelMap | Resource)
**参数:**
**参数:**
| 参数名
| 参数类型 | 必填 | 默认值 | 参数描述
|
| 参数名
| 参数类型 | 必填 | 参数描述
|
| ----
| ---------------------------------------- | ---- | ---- |
---------------------------------------- |
| ----
-- | ------------------------------------------------------------ | ---- | --------------------
---------------------------------------- |
| src
| string
\|
[PixelMap](../apis/js-apis-image.md#pixelmap7)
\|
[
Resource
](
../../ui/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/>
\-
支持
`dataability://`
路径前缀的字符串,用于访问通过data
ability提供的图片路径。 |
| src
| string
\|
[PixelMap](../apis/js-apis-image.md#pixelmap7)
\|
[
Resource
](
../../ui/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/>
\-
支持
`dataability://`
路径前缀的字符串,用于访问通过data
ability提供的图片路径。 |
## 属性
## 属性
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外,还支持以下属性:
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外,还支持以下属性:
| 名称 | 参数类型 |
默认值 |
描述 |
| 名称 | 参数类型 | 描述 |
| --------------------- | ------------------------------------------------------- | ------------------------
| ------------------------
------------------------------------ |
| --------------------- | ------------------------------------------------------- | ------------------------------------------------------------ |
| alt | string
\|
[
Resource
](
../../ui/ts-types.md#resource类型
)
|
- |
加载时显示的占位图,支持本地图片和网络图片。 |
| alt | string
\|
[
Resource
](
../../ui/ts-types.md#resource类型
)
| 加载时显示的占位图,支持本地图片和网络图片。 |
| objectFit |
[
ImageFit
](
ts-appendix-enums.md#imagefit
)
|
ImageFit.Cover | 设置图片的缩放类型。
|
| objectFit |
[
ImageFit
](
ts-appendix-enums.md#imagefit
)
|
设置图片的缩放类型。
<br/>
默认值:ImageFit.Cover
|
| objectRepeat |
[
ImageRepeat
](
ts-appendix-enums.md#imagerepeat
)
|
NoRepeat | 设置图片的重复样式。
<br/>
>
**说明:**
<br/>
>
-
svg类型图源不支持该属性。 |
| objectRepeat |
[
ImageRepeat
](
ts-appendix-enums.md#imagerepeat
)
|
设置图片的重复样式。
<br/>
默认值:NoRepeat
<br/>
**说明:**
<br/>
svg类型图源不支持该属性。 |
| interpolation |
[
ImageInterpolation
](
#imageinterpolation
)
|
ImageInterpolation.None | 设置图片的插值效果,即减轻低清晰度图片在放大显示的时候出现的锯齿问题,仅针对图片放大插值。
<br/>
>
**说明:**
<br/>
>
-
svg类型图源不支持该属性。
<br/>
>
-
PixelMap资源不支持该属性。 |
| interpolation |
[
ImageInterpolation
](
#imageinterpolation
)
|
设置图片的插值效果,即减轻低清晰度图片在放大显示的时候出现的锯齿问题,仅针对图片放大插值。
<br/>
默认值:ImageInterpolation.None
<br/>
**说明:**
<br/>
svg类型图源不支持该属性。
<br/>
PixelMap资源不支持该属性。 |
| renderMode |
[
ImageRenderMode
](
#imagerendermode
)
|
ImageRenderMode.Original | 设置图片渲染的模式。
<br/>
>
**说明:**
<br/>
>
-
svg类型图源不支持该属性。 |
| renderMode |
[
ImageRenderMode
](
#imagerendermode
)
|
设置图片渲染的模式。
<br/>
默认值:ImageRenderMode.Original
<br/>
**说明:**
<br/>
svg类型图源不支持该属性。 |
| sourceSize | {
<br/>
width:
number,
<br/>
height:
number
<br/>
} |
- | 设置图片裁剪尺寸,将原始图片解码成pixelMap,指定尺寸的图片,单位为px。
<br/>
>
**说明:**
<br/>
>
PixelMap资源不支持该属性。 |
| sourceSize | {
<br/>
width:
number,
<br/>
height:
number
<br/>
} |
设置图片裁剪尺寸,将原始图片解码成pixelMap,指定尺寸的图片,单位为px。
<br/>
**说明:**
<br/>
PixelMap资源不支持该属性。 |
| matchTextDirection | boolean |
false | 设置图片是否跟随系统语言方向,在RTL语言环境下显示镜像翻转显示效果。
|
| matchTextDirection | boolean |
设置图片是否跟随系统语言方向,在RTL语言环境下显示镜像翻转显示效果。
<br/>
默认值:false
|
| fitOriginalSize | boolean |
true | 图片组件尺寸未设置时,其显示尺寸是否跟随图源尺寸。
|
| fitOriginalSize | boolean |
图片组件尺寸未设置时,其显示尺寸是否跟随图源尺寸。
<br/>
默认值:true
|
| fillColor |
[
ResourceColor
](
../../ui/ts-types.md#resourcecolor8
)
|
- | 仅对svg图源生效,设置后会替换svg图片的fill颜色。
|
| fillColor |
[
ResourceColor
](
../../ui/ts-types.md#resourcecolor8
)
|
填充颜色。设置的填充颜色会覆盖在图片上。仅对svg图源生效,设置后会替换svg图片的fill颜色。
|
| autoResize | boolean |
true | 是否需要在图片解码过程中对图源做resize操作,该操作会根据显示区域的尺寸决定用于绘制的图源尺寸,有利于减少内存占用。
|
| autoResize | boolean |
是否需要在图片解码过程中对图源做resize操作,该操作会根据显示区域的尺寸决定用于绘制的图源尺寸,有利于减少内存占用。
<br/>
默认值:true
|
| syncLoad
<sup>
8+
</sup>
| boolean |
false | 设置是否同步加载图片,默认是异步加载。同步加载时阻塞UI线程,不会显示占位图。
|
| syncLoad
<sup>
8+
</sup>
| boolean |
设置是否同步加载图片,默认是异步加载。同步加载时阻塞UI线程,不会显示占位图。
<br/>
默认值:false
|
| copyOption
<sup>
9+
</sup>
|
[
CopyOptions
](
ts-appendix-enums.md#copyoptions9
)
|
CopyOptions.None | 设置图片是否可复制(SVG图片不支持复制)。
<br/>
当设置copyOption为非CopyOptions.None时,支持快捷组合键'CTRL+C'进行复制。
|
| copyOption
<sup>
9+
</sup>
|
[
CopyOptions
](
ts-appendix-enums.md#copyoptions9
)
|
设置图片是否可复制(SVG图片不支持复制)。
<br/>
当copyOption设置为非CopyOptions.None时,支持使用长按、鼠标右击、快捷组合键'CTRL+C'等方式进行复制。
<br/>
默认值:CopyOptions.None
|
| colorFilter
<sup>
9+
</sup>
|
[
ColorFilter
](
../../ui/ts-types.md#colorfilter9
)
|
- |
给图像设置颜色滤镜效果。 |
| colorFilter
<sup>
9+
</sup>
|
[
ColorFilter
](
../../ui/ts-types.md#colorfilter9
)
| 给图像设置颜色滤镜效果。 |
> **说明:**
> **说明:**
>
> 使用快捷组合键对Image组件复制的前提是,该组件必须处于获焦状态。将Image组件的属性focusable设置为true,即可使用TAB键将焦点切换到Image组件上,再将Image组件的focusOnTouch属性设置为true,即可实现点击获焦。
> 使用快捷组合键对Image组件复制的前提是,该组件必须处于获焦状态。将Image组件的属性focusable设置为true,即可使用TAB键将焦点切换到Image组件上,再将Image组件的focusOnTouch属性设置为true,即可实现点击获焦。
### ImageInterpolation
### ImageInterpolation
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md
浏览文件 @
5a2d2aa0
# Navigation
# Navigation
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
Navigation组件一般作为Page页面的根容器,通过属性设置来展示页面的标题、工具栏、菜单。
Navigation组件一般作为Page页面的根容器,通过属性设置来展示页面的标题、工具栏、菜单。
> **说明:**
## 权限列表
>
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
无
## 子组件
## 子组件
...
@@ -23,43 +18,47 @@ Navigation()
...
@@ -23,43 +18,47 @@ Navigation()
创建可以根据属性设置,自动展示导航栏、标题、工具栏的组件。
创建可以根据属性设置,自动展示导航栏、标题、工具栏的组件。
## 属性
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外,还支持以下属性:
| -------------- | ---------------------------------------- | ------------------------ | ---------------------------------------- |
| title | string
\|
[
CustomBuilder
](
../../ui/ts-types.md
)
| - | 页面标题。 |
| 名称 | 参数类型 | 描述 |
| subTitle | string | - | 页面副标题。 |
| -------------- | ---------------------------------------- | ---------------------------------------- |
| menus | Array
<NavigationMenuItem
&
gt
;&
nbsp
;\|&
nbsp
;[
CustomBuilder
](../../
ui
/
ts-types.md
)<
sup
>
8+
</sup>
| - | 页面右上角菜单。 |
| title | string
\|
[
CustomBuilder
](
../../ui/ts-types.md
)
| 页面标题。 |
| titleMode | NavigationTitleMode | NavigationTitleMode.Free | 页面标题栏显示模式。 |
| subTitle | string | 页面副标题。 |
| toolBar | {
<br/>
items:Array
<
Object
>
}
<br/>
\|
[
CustomBuilder
](
../../ui/ts-types.md#custombuilder8
)
<sup>
8+
</sup>
| - | 设置工具栏内容。
<br/>
items:
工具栏所有项。 |
| menus | Array
<NavigationMenuItem
&
gt
;&
nbsp
;\|&
nbsp
;[
CustomBuilder
](../../
ui
/
ts-types.md
)<
sup
>
8+
</sup>
| 页面右上角菜单。 |
| hideToolBar | boolean | false | 设置隐藏/显示工具栏:
<br/>
true:
隐藏工具栏。
<br/>
false:
显示工具栏。 |
| titleMode | NavigationTitleMode | 页面标题栏显示模式。
<br/>
默认值:NavigationTitleMode.Free |
| hideTitleBar | boolean | false | 隐藏标题栏。 |
| toolBar | object
\|
[
CustomBuilder
](
../../ui/ts-types.md#custombuilder8
)
<sup>
8+
</sup>
| 设置工具栏内容。
<br/>
items:
工具栏所有项。 |
| hideBackButton | boolean | false | 隐藏返回键。 |
| hideToolBar | boolean | 设置隐藏/显示工具栏:
<br/>
默认值:false
<br/>
true:
隐藏工具栏。
<br/>
false:
显示工具栏。 |
| hideTitleBar | boolean | 隐藏标题栏。
<br/>
默认值:false |
-
NavigationMenuItem类型接口说明
| hideBackButton | boolean | 隐藏返回键。
<br/>
默认值:false |
| 名称 | 类型 | 必填 | 默认值 | 描述 |
| ------ | ----------------------- | ---- | ---- | --------------- |
## NavigationMenuItem类型说明
| value | string | 是 | - | 菜单栏单个选项的显示文本。 |
| icon | string | 否 | - | 菜单栏单个选项的图标资源路径。 |
| 名称 | 类型 | 必填 | 描述 |
| action | ()
=
>
void | 否 | - | 当前选项被选中的事件回调。 |
| ------ | ----------------------- | ---- | ------------------------------ |
| value | string | 是 | 菜单栏单个选项的显示文本。 |
-
Object类型说明
| icon | string | 否 | 菜单栏单个选项的图标资源路径。 |
| 名称 | 类型 | 必填 | 默认值 | 描述 |
| action | ()
=
>
void | 否 | 当前选项被选中的事件回调。 |
| ------ | ----------------------- | ---- | ---- | --------------- |
| value | string | 是 | - | 工具栏单个选项的显示文本。 |
## object类型说明
| icon | string | 否 | - | 工具栏单个选项的图标资源路径。 |
| action | ()
=
>
void | 否 | - | 当前选项被选中的事件回调。 |
| 名称 | 类型 | 必填 | 描述 |
| ------ | ----------------------- | ---- | ------------------------------ |
-
NavigationTitleMode枚举说明
| value | string | 是 | 工具栏单个选项的显示文本。 |
| 名称 | 描述 |
| icon | string | 否 | 工具栏单个选项的图标资源路径。 |
| ---- | ---------------------------------------- |
| action | ()
=
>
void | 否 | 当前选项被选中的事件回调。 |
| Free | 当内容为可滚动组件时,标题随着内容向上滚动而缩小(子标题的大小不变、淡出)。向下滚动内容到顶时则恢复原样。 |
| Mini | 固定为小标题模式(图标+主副标题)。 |
## NavigationTitleMode枚举说明
| Full | 固定为大标题模式(主副标题)。 |
| 名称 | 描述 |
>  **说明:**
| ---- | ---------------------------------------- |
> 目前可滚动组件只支持List。
| Free | 当内容为可滚动组件时,标题随着内容向上滚动而缩小(子标题的大小不变、淡出)。向下滚动内容到顶时则恢复原样。 |
| Mini | 固定为小标题模式(图标+主副标题)。 |
| Full | 固定为大标题模式(主副标题)。 |
> **说明:**
> 目前可滚动组件只支持List。
## 事件
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-patternlock.md
浏览文件 @
5a2d2aa0
...
@@ -6,10 +6,6 @@
...
@@ -6,10 +6,6 @@
>
>
> 该组件从API Version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 子组件
## 子组件
无
无
...
@@ -18,29 +14,31 @@
...
@@ -18,29 +14,31 @@
PatternLock(controller?: PatternLockController)
PatternLock(controller?: PatternLockController)
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 描述
|
| 参数名 | 参数类型 | 必填 | 描述
|
| ---------- | ---------------------------------------- | ---- | ---- |
---------------------- |
| ---------- | ----------------------------------------------- | ---- | --------------------------------------
---------------------- |
| controller |
[
PatternLockController
](
#patternlockcontroller
)
| 否 | null | 给组件绑定一个控制器,用来控制组件状态重置。
|
| controller |
[
PatternLockController
](
#patternlockcontroller
)
| 否 | 给组件绑定一个控制器,用来控制组件状态重置。
<br/>
默认值:null
|
## 属性
## 属性
不支持
`backgroundColor`
以外的通用属性设置。
不支持
`backgroundColor`
以外的通用属性设置。
| 名称
| 参数类型 | 默认值 | 描述
|
| 名称
| 参数类型 | 描述
|
| --------------- | ------------------------------------- | -----------
|
---------------------------------------- |
| --------------- | ------------------------------------- | -----------
---------
---------------------------------------- |
| sideLength |
Length | 300vp | 设置组件的宽度和高度(相同值)。最小可以设置为0。
|
| sideLength |
[
Length
](
../../ui/ts-types.md
)
| 设置组件的宽度和高度(相同值)。最小可以设置为0。
<br/>
默认值:300vp
|
| circleRadius |
Length | 14vp | 设置宫格圆点的半径。
|
| circleRadius |
[
Length
](
../../ui/ts-types.md
)
| 设置宫格圆点的半径。
<br/>
默认值:14vp
|
| regularColor |
[
ResourceColor
](
../../ui/ts-types.md
)
|
Color.Black | 设置宫格圆点在“未选中”状态的填充颜色。
|
| regularColor |
[
ResourceColor
](
../../ui/ts-types.md
)
|
设置宫格圆点在“未选中”状态的填充颜色。
<br/>
默认值:Color.Black
|
| selectedColor |
[
ResourceColor
](
../../ui/ts-types.md
)
|
Color.Black | 设置宫格圆点在“选中”状态的填充颜色。
|
| selectedColor |
[
ResourceColor
](
../../ui/ts-types.md
)
|
设置宫格圆点在“选中”状态的填充颜色。
<br/>
默认值:Color.Black
|
| activeColor |
[
ResourceColor
](
../../ui/ts-types.md
)
|
Color.Black | 设置宫格圆点在“激活”状态的填充颜色。
|
| activeColor |
[
ResourceColor
](
../../ui/ts-types.md
)
|
设置宫格圆点在“激活”状态的填充颜色。
<br/>
默认值:Color.Black
|
| pathColor |
[
ResourceColor
](
../../ui/ts-types.md
)
|
Color.Blue | 设置连线的颜色。
|
| pathColor |
[
ResourceColor
](
../../ui/ts-types.md
)
|
设置连线的颜色。
<br/>
默认值:Color.Blue
|
| pathStrokeWidth |
Length | 34vp | 设置连线的宽度。最小可以设置为0。
|
| pathStrokeWidth |
number
\|
string | 设置连线的宽度。最小可以设置为0。
<br/>
默认值:34vp
|
| autoReset | boolean |
true | 设置是否支持用户在完成输入后再次触屏重置组件状态。如果设置为true,用户可以通过触摸图案密码锁重置组件状态(清除之前的输入效果);如果设置为false,用户手指离开屏幕完成输入后,再次触摸图案密码锁(包括圆点)不能改变之前的输入状态。
|
| autoReset | boolean |
设置是否支持用户在完成输入后再次触屏重置组件状态。如果设置为true,用户可以通过触摸图案密码锁重置组件状态(清除之前的输入效果);如果设置为false,用户手指离开屏幕完成输入后,再次触摸图案密码锁(包括圆点)不能改变之前的输入状态。
<br/>
默认值:true
|
## 事件
## 事件
除支持
[
通用事件
](
ts-universal-events-click.md
)
外,还支持以下事件:
| 名称 | 描述 |
| 名称 | 描述 |
| ---------------------------------------- | ---------------------------------------- |
| ---------------------------------------- | ---------------------------------------- |
| onPatternComplete(callback: (input: Array
\<
number
\>
) => void) | 密码输入结束时被调用的回调函数。
<br
/>
input: 与选中宫格圆点顺序一致的数字数组,数字为选中宫格的索引(0到8)。 |
| onPatternComplete(callback: (input: Array
\<
number
\>
) => void) | 密码输入结束时被调用的回调函数。
<br
/>
input: 与选中宫格圆点顺序一致的数字数组,数字为选中宫格的索引(0到8)。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-plugincomponent.md
浏览文件 @
5a2d2aa0
# PluginComponent
# PluginComponent
提供外部应用组件嵌入式显示功能,即外部应用提供的UI可在本应用内显示。
> **说明:**
> **说明:**
>
>
...
@@ -8,14 +10,6 @@
...
@@ -8,14 +10,6 @@
> - 本组件为系统接口。
> - 本组件为系统接口。
提供外部应用组件嵌入式显示功能,即外部应用提供的UI可在本应用内显示。
## 权限列表
无
## 子组件
## 子组件
无
无
...
@@ -23,20 +17,22 @@
...
@@ -23,20 +17,22 @@
## 接口
## 接口
PluginComponent(value: { template: PluginComponentTemplate, data:
any
})
PluginComponent(value: { template: PluginComponentTemplate, data:
KVObject
})
创建插件组件,用于显示外部应用提供的UI。
创建插件组件,用于显示外部应用提供的UI。
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ---------------------------------------- | ---- | ---- | ---------------------------------------- |
| value | {
<br/>
template:
PluginComponentTemplate,
<br/>
data:
KVObject
<br/>
} | 是 | - | template:
组件模板,用于跟提供者定义的组件绑定。
<br/>
data:
传给插件组件提供者使用的数据。 |
-
PluginComponentTemplate类型说明
| 参数名 | 参数类型 | 必填 | 参数描述 |
| 参数 | 类型 | 描述 |
| ------ | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| ------- | ------ | ----------------------- |
| value | {
<br/>
template:
PluginComponentTemplate,
<br/>
data:
KVObject
<br/>
} | 是 | template:
组件模板,用于跟提供者定义的组件绑定。
<br/>
data:
传给插件组件提供者使用的数据。 |
| source | string | 组件模板名。 |
| ability | string | 提供者Ability的abilityname。 |
## PluginComponentTemplate类型说明
| 参数 | 类型 | 描述 |
| ------- | ------ | ----------------------- |
| source | string | 组件模板名。 |
| ability | string | 提供者Ability的abilityname。 |
## 事件
## 事件
...
@@ -66,24 +62,25 @@ push(param: PushParameters, callback: AsyncCallback<void>): void
...
@@ -66,24 +62,25 @@ push(param: PushParameters, callback: AsyncCallback<void>): void
组件提供者向组件使用者主动发送组件与数据。
组件提供者向组件使用者主动发送组件与数据。
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------------------------- |
| param | PushParameters | 是 | 组件使用者的详细信息,详见PushParameters参数说明。 |
| callback | AsyncCallback
<
void
>
| 是 | 此次接口调用的异步回调。 |
-
参数
**PushParameters参数说明**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------------------------- |
| param | PushParameters | 是 | 组件使用者的详细信息,详见PushParameters参数说明。 |
| callback | AsyncCallback
<
void
>
| 是 | 此次接口调用的异步回调。 |
-
PushParameters参数说明
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------- | ---- | --------------- |
| --------- | -------- | ---- | --------------- |
| want | Want | 是 | 组件使用者Ability信息。 |
| want | Want | 是 | 组件使用者Ability信息。 |
| name | string | 是 | 组件名称。 |
| name | string | 是 | 组件名称。 |
| data | KVObject | 否 | 组件数据值。 |
| data | KVObject | 否 | 组件数据值。 |
| extraData | KVObject | 否 | 附加数据值。 |
| extraData | KVObject | 否 | 附加数据值。 |
-
示例
**示例**
见
[
Plugin组件提供方
](
#组件提供方
)
示例。
见
[
Plugin组件提供方
](
#组件提供方
)
示例。
## request
## request
...
@@ -92,35 +89,38 @@ request(param: RequestParameters, callback: AsyncCallback<RequestCallbackPara
...
@@ -92,35 +89,38 @@ request(param: RequestParameters, callback: AsyncCallback<RequestCallbackPara
组件使用者向组件提供者主动请求组件。
组件使用者向组件提供者主动请求组件。
-
参数
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------ |
| 参数名 | 类型 | 必填 | 说明 |
| param | RequestParameters | 是 | 组件模板的详细请求信息,详见RequestParameters参数说明。 |
| -------- | ---------------------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback<RequestCallbackParameters
\|
void
>
| 是 | 此次请求的异步回调,
通过回调接口的参数返回接受请求的数据。 |
| param | RequestParameters | 是 | 组件模板的详细请求信息,详见RequestParameters参数说明。 |
| callback | AsyncCallback<RequestCallbackParameters
\|
void
>
| 是 | 此次请求的异步回调,
通过回调接口的参数返回接受请求的数据。 |
**RequestParameters参数说明**
-
RequestParameters参数说明
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | -------- | ---- | --------------- |
| ---- | -------- | ---- | --------------- |
| want | Want | 是 | 组件提供者Ability信息。 |
| want | Want | 是 | 组件提供者Ability信息。 |
| name | string | 是 | 请求组件名称。 |
| name | string | 是 | 请求组件名称。 |
| data | KVObject | 是 | 附加数据。 |
| data | KVObject | 是 | 附加数据。 |
-
RequestCallbackParameters说明
**RequestCallbackParameters说明**
| 名称 | 类型 | 说明 |
| ----------------- | ----------------------- | ----- |
| componentTemplate | PluginComponentTemplate | 组件模板。 |
| data | KVObject | 组件数据。 |
| extraData | KVObject | 附加数据。 |
-
KVObject类型说明
| 名称 | 类型 | 说明 |
| 参数 | 类型 | 说明 |
| ----------------- | ----------------------- | ----- |
| ---- | ---------------------------------------- | ---------------------------------------- |
| componentTemplate | PluginComponentTemplate | 组件模板。 |
| key | number
\|
string
\|
boolean
\|
Array
\|
KVObject | KVObject用[key,value]来存储数据,key是string类型的,value可以是number,string,boolean,数组或者另外的一个KVObject。 |
| data | KVObject | 组件数据。 |
| extraData | KVObject | 附加数据。 |
**KVObject类型说明**
-
示例
| 参数 | 类型 | 说明 |
| ---- | ---------------------------------------- | ---------------------------------------- |
| key | number
\|
string
\|
boolean
\|
Array
\|
KVObject | KVObject用[key,value]来存储数据,key是string类型的,value可以是number,string,boolean,数组或者另外的一个KVObject。 |
见
[
Plugin组件使用方
](
#组件使用方
)
示例。
**示例**
见
[
Plugin组件使用方
](
#组件使用方
)
示例。
## on
## on
...
@@ -129,28 +129,31 @@ on(eventType: string, callback: OnPushEventCallback | OnRequestEventCallback): v
...
@@ -129,28 +129,31 @@ on(eventType: string, callback: OnPushEventCallback | OnRequestEventCallback): v
提供者监听"request"类型的事件,给使用者返回通过request接口主动请求的数据;使用者监听"push"类型的事件,接收提供者通过push接口主动推送的数据。
提供者监听"request"类型的事件,给使用者返回通过request接口主动请求的数据;使用者监听"push"类型的事件,接收提供者通过push接口主动推送的数据。
-
参数
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | ---------------------------------------- |
| 参数名 | 类型 | 必填 | 说明 |
| eventType | string | 是 | 监听的事件类型,
可选值为:"push"
、"request"。
<br/>
"push”:指组件提供者向使用者主动推送数据。
<br/>
"request”:指组件使用者向提供者主动请求数据。 |
| --------- | ---------------------------------------- | ---- | ---------------------------------------- |
| callback | OnPushEventCallback
\|
OnRequestEventCallback | 是 | 见callback事件说明。 |
| eventType | string | 是 | 监听的事件类型,
可选值为:"push"
、"request"。
<br/>
"push”:指组件提供者向使用者主动推送数据。
<br/>
"request”:指组件使用者向提供者主动请求数据。 |
| callback | OnPushEventCallback
\|
OnRequestEventCallback | 是 | 见callback事件说明。 |
**callback事件说明**
| 参数名 | 类型 | 说明 |
| ---------------------- | ---------------------------------------- | ---------------------------------------- |
| OnRequestEventCallback | (source:
Want,
<br/>
name:
string,
<br/>
data:
KVObject
)
=>RequestEventResult | 数据请求事件的回调。
<br/>
source:
组件请求方Ability信息。
<br/>
name:
请求组件名称。
<br/>
data:
附加数据。
<br/>
返回值:
请求数据结果。 |
| OnPushEventCallback | (source:
Want,
<br/>
template:
PluginComponentTemplate,
<br/>
data:
KVObject,
<br/>
extraData:
KVObject
<br/>
)
=
>
void | 接收提供者主动推送的数据。
<br/>
source:
组件提供者Ability信息。
<br/>
template:
组件模板。
<br/>
data:
组件更新数据。
<br/>
extraData:
附加数据。 |
-
callback事件说明
**RequestEventResult类型说明**
| 参数名 | 类型 | 说明 |
| ---------------------- | ---------------------------------------- | ---------------------------------------- |
| OnRequestEventCallback | (source:
Want,
<br/>
name:
string,
<br/>
data:
KVObject
)
=>RequestEventResult | 数据请求事件的回调。
<br/>
source:
组件请求方Ability信息。
<br/>
name:
请求组件名称。
<br/>
data:
附加数据。
<br/>
返回值:
请求数据结果。 |
| OnPushEventCallback | (source:
Want,
<br/>
template:
PluginComponentTemplate,
<br/>
data:
KVObject,
<br/>
extraData:
KVObject
<br/>
)
=
>
void | 接收提供者主动推送的数据。
<br/>
source:
组件提供者Ability信息。
<br/>
template:
组件模板。
<br/>
data:
组件更新数据。
<br/>
extraData:
附加数据。 |
-
RequestEventResult类型说明
| 参数 | 类型 | 说明 |
| 参数 | 类型 | 说明 |
| --------- | -------- | ---------- |
| --------- | -------- | ----- |
| template | string | 组件名称。 |
| template | string | 组件名称。 |
| data | KVObject | 组件数据。 |
| data | KVObject | 组件数据。 |
| extraData | KVObject | 附加数据。 |
| extraData | KVObjec | 附加数据。 |
-
示例
**示例**
见
[
Plugin组件工具
](
#P
lugin组件工具
)
示例。
见
[
Plugin组件工具
](
#p
lugin组件工具
)
示例。
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md
浏览文件 @
5a2d2aa0
# Progress
# Progress
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
进度条,用于显示内容加载或操作处理进度。
进度条,用于显示内容加载或操作处理进度。
> **说明:**
## 权限列表
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
无
## 子组件
## 子组件
...
@@ -23,31 +18,33 @@ Progress(options: {value: number, total?: number, type?: ProgressType})
...
@@ -23,31 +18,33 @@ Progress(options: {value: number, total?: number, type?: ProgressType})
创建进度组件,用于显示内容加载或操作处理进度。
创建进度组件,用于显示内容加载或操作处理进度。
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| value | number | 是 | - | 指定当前进度值。 |
| total | number | 否 | 100 | 指定进度总长。 |
| type | ProgressType | 否 | ProgressType.Linear | 指定进度条样式。 |
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| value | number | 是 | 指定当前进度值。 |
| total | number | 否 | 指定进度总长。
<br/>
默认值:100 |
| type | ProgressType | 否 | 指定进度条样式。
<br/>
默认值:ProgressType.Linear |
-
ProgressType枚举说明
## ProgressType枚举说明
| 名称 | 描述 |
| -------- | -------- |
| Linear
<sup>
8+
</sup>
| 线性样式。 |
| Ring
<sup>
8+
</sup>
| 环形无刻度样式,环形圆环逐渐填充完成过程。 |
| Eclipse
<sup>
8+
</sup>
| 圆形样式,展现类似月圆月缺的进度展示效果,从月牙逐渐到满月的这个过程代表了下载的进度。 |
| ScaleRing
<sup>
8+
</sup>
| 环形有刻度样式,类似时钟刻度形式加载进度。 |
| Capsule
<sup>
8+
</sup>
| 胶囊样式,头尾两端处,进度条由弧形变成直线和直线变成弧形的过程;中段处,进度条正常往右走的过程。 |
| 名称 | 描述 |
| -------- | -------- |
| Linear
<sup>
8+
</sup>
| 线性样式。 |
| Ring
<sup>
8+
</sup>
| 环形无刻度样式,环形圆环逐渐填充完成过程。 |
| Eclipse
<sup>
8+
</sup>
| 圆形样式,展现类似月圆月缺的进度展示效果,从月牙逐渐到满月的这个过程代表了下载的进度。 |
| ScaleRing
<sup>
8+
</sup>
| 环形有刻度样式,类似时钟刻度形式加载进度。 |
| Capsule
<sup>
8+
</sup>
| 胶囊样式,头尾两端处,进度条由弧形变成直线和直线变成弧形的过程;中段处,进度条正常往右走的过程。 |
## 属性
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外,还支持以下属性:
| -------- | -------- | -------- | -------- |
| value | number | - | 设置当前进度值。 |
| 名称 | 参数类型 | 描述 |
| color |
[
ResourceColor
](
../../ui/ts-types.md
)
| - | 设置进度条前景色。 |
| -------- | -------- | -------- |
| style
<sup>
8+
</sup>
| {
<br/>
strokeWidth?:
Length,
<br/>
scaleCount?:
number,
<br/>
scaleWidth?:
Length
<br/>
} | - | 定义组件的样式。
<br/>
strokeWidth:
设置进度条宽度。
<br/>
scaleCount:
设置环形进度条总刻度数。
<br/>
scaleWidth:
设置环形进度条刻度粗细。
<br/>
刻度粗细大于进度条宽度时,刻度粗细为系统默认粗细。 |
| value | number | 设置当前进度值。 |
| color |
[
ResourceColor
](
../../ui/ts-types.md
)
| 设置进度条前景色。 |
| style
<sup>
8+
</sup>
| {
<br/>
strokeWidth?:
[Length](../../ui/ts-types.md),
<br/>
scaleCount?:
number,
<br/>
scaleWidth?:
[
Length
](
../../ui/ts-types.md
)
<br/>
} | 定义组件的样式。
<br/>
strokeWidth:
设置进度条宽度。
<br/>
scaleCount:
设置环形进度条总刻度数。
<br/>
scaleWidth:
设置环形进度条刻度粗细。刻度粗细大于进度条宽度时,刻度粗细为系统默认粗细。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md
浏览文件 @
5a2d2aa0
...
@@ -6,11 +6,6 @@
...
@@ -6,11 +6,6 @@
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 子组件
## 子组件
无
无
...
@@ -20,23 +15,25 @@
...
@@ -20,23 +15,25 @@
QRCode(value: string)
QRCode(value: string)
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| value | string | 是 | - | 二维码内容字符串。 |
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| value | string | 是 | 二维码内容字符串。 |
## 属性
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外,还支持以下属性。
| -------- | -------- | -------- | -------- |
| color |
[
ResourceColor
](
../../ui/ts-types.md
)
| Black | 设置二维码颜色。 |
| 名称 | 参数类型 | 描述 |
| backgroundColor |
[
ResourceColor
](
../../ui/ts-types.md
)
| - | 设置二维码背景颜色。 |
| -------- | -------- | -------- |
| color |
[
ResourceColor
](
../../ui/ts-types.md
)
| 设置二维码颜色。
<br/>
默认值:Color.Black |
| backgroundColor |
[
ResourceColor
](
../../ui/ts-types.md
)
| 设置二维码背景颜色。
<br/>
默认值:Color.White |
## 事件
## 事件
通用事件仅支持
点击事件
。
通用事件仅支持
[
点击事件
](
ts-universal-events-click.md
)
。
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-radio.md
浏览文件 @
5a2d2aa0
# Radio
# Radio
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
单选框,提供相应的用户交互选择项。
单选框,提供相应的用户交互选择项。
> **说明:**
## 权限列表
>
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
无
## 子组件
## 子组件
...
@@ -21,23 +16,26 @@
...
@@ -21,23 +16,26 @@
Radio(options: {value: string, group: string})
Radio(options: {value: string, group: string})
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| value | string | 是 | - | 当前单选框的值。|
| group | string | 是 | - | 当前单选框的所属群组名称,相同group的Radio只能有一个被选中。|
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| value | string | 是 | 当前单选框的值。|
| group | string | 是 | 当前单选框的所属群组名称,相同group的Radio只能有一个被选中。|
## 属性
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外,还支持以下属性:
| -------- | -------- | -------- | -------- |
| checked | boolean | false | 设置单选框的选中状态。 |
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| checked | boolean | 设置单选框的选中状态。
<br/>
默认值:false |
## 事件
## 事件
| 名称 | 功能描述 |
除支持
[
通用事件
](
ts-universal-events-click.md
)
外,还支持以下事件:
| 名称 | 功能描述 |
| -------- | -------- |
| -------- | -------- |
| onChange(callback: (isChecked: boolean) => void) | 单选框选中状态改变时触发回调。
<br>
-isChecked为true时,代表选中。
<br>
-isChecked为false时,代表未选中。 |
| onChange(callback: (isChecked: boolean) => void) | 单选框选中状态改变时触发回调。
<br>
-isChecked为true时,代表选中。
<br>
-isChecked为false时,代表未选中。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md
浏览文件 @
5a2d2aa0
# Search
# Search
提供搜索框组件,用于提供用户搜索内容的输入区域。
> **说明:**
> **说明:**
>
>
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
提供搜索框组件,用于提供用户搜索内容的输入区域。
## 权限列表
无
## 子组件
## 子组件
无
无
...
@@ -18,25 +14,27 @@
...
@@ -18,25 +14,27 @@
Search(options?: { value?: string; placeholder?: string; icon?: string; controller?: SearchController })
Search(options?: { value?: string; placeholder?: string; icon?: string; controller?: SearchController })
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----------- | ---------------- | ---- | ---- | ---------------------------------------- |
| value | string | 否 | - | 搜索文本值。 |
| placeholder | string | 否 | - | 无输入时的提示文本。 |
| icon | string | 否 | - | 搜索图标路径,默认使用系统搜索图标,支持的图标格式: svg, jpg和png。 |
| controller | SearchController | 否 | - | 控制器。 |
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ----------- | ---------------- | ---- | ------------------------------------------------------------ |
| value | string | 否 | 搜索文本值。 |
| placeholder | string | 否 | 无输入时的提示文本。 |
| icon | string | 否 | 搜索图标路径,默认使用系统搜索图标,支持的图标格式: svg、jpg和png。 |
| controller | SearchController | 否 | 控制器。 |
## 属性
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外,还支持以下属性:
| ----------------------- | ---------------------------------------- | ---- | --------------------- |
| searchButton | string | 无 | 搜索框末尾搜索按钮文本值,默认无搜索按钮。 |
| 名称 | 参数类型 | 描述 |
| placeholderColor |
[
ResourceColor
](
../../ui/ts-types.md
)
| - | 设置placeholder颜色。 |
| ----------------------- | ------------------------------------------------ | ---------------------------------------------- |
| placeholderFont |
[
Font
](
../../ui/ts-types.md
)
| - | 设置placeholder文本样式。 |
| searchButton | string | 搜索框末尾搜索按钮文本值,默认无搜索按钮。 |
| textFont |
[
Font
](
../../ui/ts-types.md
)
| - | 设置搜索框内文本样式。 |
| placeholderColor |
[
ResourceColor
](
../../ui/ts-types.md
)
| 设置placeholder颜色。 |
| copyOption
<sup>
9+
</sup>
|
[
CopyOptions
](
ts-basic-components-text.md
)
| CopyOptions.CrossDevice | 设置文本是否可复制。 |
| placeholderFont |
[
Font
](
../../ui/ts-types.md
)
| 设置placeholder文本样式。 |
| textFont |
[
Font
](
../../ui/ts-types.md
)
| 设置搜索框内文本样式。 |
| copyOption
<sup>
9+
</sup>
|
[
CopyOptions
](
ts-appendix-enums.md#copyoptions9
)
| 设置文本是否可复制。 |
| textAlign |
[
TextAlign
](
ts-appendix-enums.md#textalign
)
| 设置文本对齐方式。
<br/>
默认值:TextAlign.Start |
## 事件
## 事件
...
@@ -62,13 +60,11 @@ caretPosition(value: number): void
...
@@ -62,13 +60,11 @@ caretPosition(value: number): void
设置输入光标的位置。
设置输入光标的位置。
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ------ | ---- | ---- | ----------------- |
| value | number | 是 | - | 从字符串开始到光标所在位置的长度。 |
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ------ | -------- | ---- | ---------------------------------- |
| value | number | 是 | 从字符串开始到光标所在位置的长度。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md
浏览文件 @
5a2d2aa0
...
@@ -3,12 +3,8 @@
...
@@ -3,12 +3,8 @@
可以输入单行文本并支持响应输入事件的组件。
可以输入单行文本并支持响应输入事件的组件。
> **说明:**
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 子组件
## 子组件
...
@@ -20,53 +16,58 @@
...
@@ -20,53 +16,58 @@
TextInput(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: TextInputController})
TextInput(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: TextInputController})
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----------------------- | ---------------------------------------- | ---- | ---- | --------------- |
| 参数名 | 参数类型 | 必填 | 参数描述 |
| placeholder |
[
ResourceStr
](
../../ui/ts-types.md
)
| 否 | - | 无输入时的提示文本。 |
| ----------------------- | ---------------------------------------- | ---- | --------------- |
| text |
[
ResourceStr
](
../../ui/ts-types.md
)
| 否 | - | 设置输入框当前的文本内容。 |
| placeholder |
[
ResourceStr
](
../../ui/ts-types.md
)
| 否 | 无输入时的提示文本。 |
| controller
<sup>
8+
</sup>
|
[
TextInputController
](
#textinputcontroller8
)
| 否 | - | 设置TextInput控制器。 |
| text |
[
ResourceStr
](
../../ui/ts-types.md
)
| 否 | 设置输入框当前的文本内容。 |
| controller
<sup>
8+
</sup>
|
[
TextInputController
](
#textinputcontroller8
)
| 否 | 设置TextInput控制器。 |
## 属性
## 属性
除支持通用属性外,还支持以下属性:
除支持通用属性外,还支持以下属性:
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 描述 |
| ------------------------ | ---------------------------------------- | ----------------- | ---------------------------------------- |
| ------------------------ | ---------------------------------------- | ---------------------------------------- |
| type | InputType | InputType.Normal | 设置输入框类型。 |
| type | InputType | 设置输入框类型。
<br/>
默认值:InputType.Normal |
| placeholderColor |
[
ResourceColor
](
../../ui/ts-types.md
)
| - | 设置placeholder颜色。|
| placeholderColor |
[
ResourceColor
](
../../ui/ts-types.md
)
| 设置placeholder颜色。|
| placeholderFont | {
<br/>
size?:
Length,
<br/>
weight?:
number\|[FontWeight](ts-universal-attributes-text-style.md),
<br/>
family?:
string,
<br/>
style?:
[
FontStyle
](
ts-universal-attributes-text-style.md
)
<br/>
} | - | 设置placeholder文本样式:
<br/>
-
size:
设置文本尺寸,Length为number类型时,使用fp单位。
<br/>
-
weight:
设置文本的字体粗细,number类型取值[100,
900],取值间隔为100,默认为400,取值越大,字体越粗。
<br/>
-
family:
设置文本的字体列表。使用多个字体,使用','进行分割,优先级按顺序生效。例如:'Arial,
sans-serif'。
<br/>
-
style:
设置文本的字体样式。 |
| placeholderFont | {
<br/>
size?:
Length,
<br/>
weight?:
number\|[FontWeight](ts-universal-attributes-text-style.md),
<br/>
family?:
string,
<br/>
style?:
[
FontStyle
](
ts-universal-attributes-text-style.md
)
<br/>
} | 设置placeholder文本样式:
<br/>
-
size:
设置文本尺寸,Length为number类型时,使用fp单位。
<br/>
-
weight:
设置文本的字体粗细,number类型取值[100,
900],取值间隔为100,默认为400,取值越大,字体越粗。
<br/>
-
family:
设置文本的字体列表。使用多个字体,使用','进行分割,优先级按顺序生效。例如:'Arial,
sans-serif'。
<br/>
-
style:
设置文本的字体样式。 |
| enterKeyType | EnterKeyType | EnterKeyType.Done | 设置输入法回车键类型。 |
| enterKeyType | EnterKeyType | 设置输入法回车键类型。
<br/>
默认值:EnterKeyType.Done |
| caretColor |
[
ResourceColor
](
../../ui/ts-types.md
)
| - | 设置输入框光标颜色。 |
| caretColor |
[
ResourceColor
](
../../ui/ts-types.md
)
| 设置输入框光标颜色。 |
| maxLength | number | - | 设置文本的最大输入字符数。 |
| maxLength | number | 设置文本的最大输入字符数。 |
| inputFilter
<sup>
8+
</sup>
| {
<br/>
value:
[ResourceStr](../../ui/ts-types.md)
<sup>
8+
</sup>
,
<br/>
error?:
(value:
string)
=
>
void
<br/>
} | - | 正则表达式,满足表达式的输入允许显示,不满足正则表达式的输入被忽略。仅支持单个字符匹配,不支持字符串匹配。例如:^(?=.
\*\d
)(?=.
\*
[a-z])(?=.
\*
[A-Z]).{8,10}$,8到10位的强密码不支持过滤。
<br/>
-
value:设置正则表达式。
<br/>
-
error:正则匹配失败时,返回被忽略的内容。 |
| inputFilter
<sup>
8+
</sup>
| {
<br/>
value:
[ResourceStr](../../ui/ts-types.md)
<sup>
8+
</sup>
,
<br/>
error?:
(value:
string)
=
>
void
<br/>
} | 正则表达式,满足表达式的输入允许显示,不满足正则表达式的输入被忽略。仅支持单个字符匹配,不支持字符串匹配。例如:^(?=.
\*\d
)(?=.
\*
[a-z])(?=.
\*
[A-Z]).{8,10}$,8到10位的强密码不支持过滤。
<br/>
-
value:设置正则表达式。
<br/>
-
error:正则匹配失败时,返回被忽略的内容。 |
| copyOption
<sup>
9+
</sup>
|
[
CopyOptions
](
ts-basic-components-text.md
)
| CopyOptions.CrossDevice | 设置文本是否可复制。 |
| copyOption
<sup>
9+
</sup>
|
[
CopyOptions
](
ts-appendix-enums.md#copyoptions9
)
| 设置文本是否可复制。 |
| showPasswordIcon
<sup>
9+
</sup>
| boolean | true | 密码输入模式时,密码框末尾的图标是否显示。 |
| showPasswordIcon
<sup>
9+
</sup>
| boolean | 密码输入模式时,密码框末尾的图标是否显示。
<br/>
默认值:true |
| style
<sup>
9+
</sup>
| TextInputStyle | Default | TextInput风格。 |
| style
<sup>
9+
</sup>
| TextInputStyle | TextInput风格。
<br/>
默认值:TextInputStyle.Default |
-
EnterKeyType枚举说明
## EnterKeyType枚举说明
| 名称 | 描述 |
| ------------------- | --------- |
| 名称 | 描述 |
| Go | 显示Go文本。 |
| ------------------- | --------- |
| Search | 显示为搜索样式。 |
| Go | 显示Go文本。 |
| Send | 显示为发送样式。 |
| Search | 显示为搜索样式。 |
| Next | 显示为下一个样式。 |
| Send | 显示为发送样式。 |
| Done | 标准样式。 |
| Next | 显示为下一个样式。 |
| Done | 标准样式。 |
-
InputType枚举说明
| 名称 | 描述 |
## InputType枚举说明
| ------------------ | ------------- |
| Normal | 基本输入模式。 |
| 名称 | 描述 |
| Password | 密码输入模式。 |
| ------------------ | ------------- |
| Email | e-mail地址输入模式。 |
| Normal | 基本输入模式。
<br/>
支持输入数字、字母、下划线、空格、特殊字符。 |
| Number | 纯数字输入模式。 |
| Password | 密码输入模式。 |
| Email | e-mail地址输入模式。 |
-
TextInputStyle枚举说明
| Number | 纯数字输入模式。 |
| 名称 | 描述 |
| PhoneNumber
<sup>
9+
</sup>
| 电话号码输入模式。
<br/>
支持输入数字、+ 、-、
*
、#,长度不限。 |
| ------------------ | ------------- |
| Default | 默认风格,光标宽1.5vp,光标高度和字体大小高度相关,字体越大光标越高。 |
## TextInputStyle枚举说明
| Inline | 内联输入风格。文字选中时底板与输入框同高。 |
| 名称 | 描述 |
| ------------------ | ------------- |
| Default | 默认风格,光标宽1.5vp,光标高度和字体大小高度相关,字体越大光标越高。 |
| Inline | 内联输入风格。文字选中时底板与输入框同高。 |
## 事件
## 事件
...
@@ -93,11 +94,12 @@ controller: TextInputController = new TextInputController()
...
@@ -93,11 +94,12 @@ controller: TextInputController = new TextInputController()
caretPosition(value:
number): void
caretPosition(value:
number): void
设置输入光标的位置。
设置输入光标的位置。
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
**参数:**
| ----- | ------ | ---- | ---- | ---------------------------------------- |
| value | number | 是 | - | 从字符串开始到光标所在位置的字符长度。 |
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ------ | -------- | ---- | -------------------------------------- |
| value | number | 是 | 从字符串开始到光标所在位置的字符长度。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-canvasrenderingcontext2d.md
浏览文件 @
5a2d2aa0
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-ellipse.md
浏览文件 @
5a2d2aa0
# Ellipse
# Ellipse
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
椭圆绘制组件。
椭圆绘制组件。
> **说明:**
## 权限列表
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
无
## 子组件
## 子组件
...
@@ -21,24 +16,21 @@
...
@@ -21,24 +16,21 @@
ellipse(options?: {width: Length, height: Length})
ellipse(options?: {width: Length, height: Length})
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| options | Object | 否 | - | 见options参数说明。 |
-
options参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| width | Length | 是 | - | 宽度。 |
| height | Length | 是 | - | 高度。 |
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| width | string
\|
number | 是 | 宽度。
<br/>
默认值:0 |
| height | string
\|
number | 是 | 高度。
<br/>
默认值:0 |
## 属性
## 属性
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
仅支持以下属性:
| -------- | -------- | -------- | -------- | -------- |
| width | Length | 0 | 否 | 椭圆所在矩形的宽度。 |
| 参数名称 | 参数类型 | 必填 | 参数描述 |
| height | Length | 0 | 否 | 椭圆所在矩形的高度。 |
| -------- | -------- | -------- | -------- |
| width | Length | 否 | 椭圆所在矩形的宽度。 |
| height | Length | 否 | 椭圆所在矩形的高度。 |
## 示例
## 示例
...
@@ -50,9 +42,9 @@ ellipse(options?: {width: Length, height: Length})
...
@@ -50,9 +42,9 @@ ellipse(options?: {width: Length, height: Length})
struct
EllipseExample
{
struct
EllipseExample
{
build
()
{
build
()
{
Flex
({
justifyContent
:
FlexAlign
.
SpaceAround
})
{
Flex
({
justifyContent
:
FlexAlign
.
SpaceAround
})
{
// 在一个 150 *
7
0 的矩形框中绘制一个椭圆
// 在一个 150 *
8
0 的矩形框中绘制一个椭圆
Ellipse
({
width
:
150
,
height
:
80
})
Ellipse
({
width
:
150
,
height
:
80
})
// 在一个 150 *
7
0 的矩形框中绘制一个椭圆
// 在一个 150 *
8
0 的矩形框中绘制一个椭圆
Ellipse
().
width
(
150
).
height
(
80
)
Ellipse
().
width
(
150
).
height
(
80
)
}.
width
(
'
100%
'
).
margin
({
top
:
5
})
}.
width
(
'
100%
'
).
margin
({
top
:
5
})
}
}
...
...
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-path.md
浏览文件 @
5a2d2aa0
...
@@ -3,14 +3,10 @@
...
@@ -3,14 +3,10 @@
路径绘制组件,根据绘制路径生成封闭的自定义形状。
路径绘制组件,根据绘制路径生成封闭的自定义形状。
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 子组件
## 子组件
无
无
...
@@ -19,25 +15,23 @@
...
@@ -19,25 +15,23 @@
Path(value?: { width?: number | string; height?: number | string; commands?: string })
Path(value?: { width?: number | string; height?: number | string; commands?: string })
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | ---- | ------ | -------------------- |
| width | Length | 否 | 0 | 路径所在矩形的宽度 |
| height | Length | 否 | 0 | 路径所在矩形的高度 |
| commands | string | 是 | ‘ ’ | 路径绘制的命令字符串 |
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | ---------------- | ---- | ----------------------------------- |
| width | number
\|
string | 否 | 路径所在矩形的宽度
<br/>
默认值:0 |
| height | number
\|
string | 否 | 路径所在矩形的高度
<br/>
默认值:0 |
| commands | string | 否 | 路径绘制的命令字符串
<br/>
默认值:'' |
## 属性
## 属性
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外,还
支持以下属性:
仅
支持以下属性:
| 参数名称
| 参数类型 | 默认值 | 必填 | 参数描述
|
| 参数名称
| 参数类型 | 必填 | 参数描述
|
| -------- | -----------------------------------
| ---- | ---- |
---------------------------------------- |
| -------- | -----------------------------------
---- | ---- | --------------------
---------------------------------------- |
| width |
[
Length
](
../../ui/ts-types.md#长度类型
)
|
0 | 否 | 路径所在矩形画布的宽度。
|
| width |
[
Length
](
../../ui/ts-types.md#长度类型
)
|
否 | 路径所在矩形画布的宽度。
<br/>
默认值:0
|
| height |
[
Length
](
../../ui/ts-types.md#长度类型
)
|
0 | 否 | 路径所在矩形画布的高度。
|
| height |
[
Length
](
../../ui/ts-types.md#长度类型
)
|
否 | 路径所在矩形画布的高度。
<br/>
默认值:0
|
| commands | string
| '' | 是 | 路径绘制的命令字符串,单位为px。像素单位转换方法请参考
[
像素单位转换
](
../../ui/ts-pixel-units.md
)
。
|
| commands | string
| 是 | 路径绘制的命令字符串,单位为px。像素单位转换方法请参考
[
像素单位转换
](
../../ui/ts-pixel-units.md
)
。
<br/>
默认值:''
|
commands支持的绘制命令如下:
commands支持的绘制命令如下:
...
...
zh-cn/application-dev/reference/arkui-ts/ts-matrix-transformation.md
浏览文件 @
5a2d2aa0
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-z-order.md
浏览文件 @
5a2d2aa0
...
@@ -3,20 +3,16 @@
...
@@ -3,20 +3,16 @@
组件的Z序,指明了该组件在堆叠组件中的位置。
组件的Z序,指明了该组件在堆叠组件中的位置。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 属性
## 属性
| 名称 | 参数类型 |
默认值 |
描述 |
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
-------- |
| -------- | -------- | -------- |
| zIndex | number |
0 | 同一容器中兄弟组件显示层级关系,z值越大,显示层级越高
。 |
| zIndex | number |
同一容器中兄弟组件显示层级关系。zIndex值越大,显示层级越高,即zIndex值大的组件会覆盖在zIndex值小的组件上方
。 |
## 示例
## 示例
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录