提交 f6cc8366 编写于 作者: H HelloCrease

update docs

Signed-off-by: NHelloCrease <lian15@huawei.com>
上级 38837e54
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
"abilities":[ "abilities":[
{ {
... ...
"permissions": ["ohos.permission.INTERNET], "permissions": ["ohos.permission.INTERNET"],
... ...
} }
] ]
...@@ -31,7 +31,7 @@ Video(value: VideoOptions) ...@@ -31,7 +31,7 @@ Video(value: VideoOptions)
- VideoOptions类型接口说明 - VideoOptions类型接口说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- | | ------------------- | ---------------------------------------- | ---- | ---------------------------------------- | ---------------------------------------- |
| src | string \| [Resource](../../ui/ts-types.md) | 否 | - | 视频播放源的路径,支持本地视频路径和网络路径。<br>支持在resources下面的video或rawfile文件夹里放置媒体资源。<br>支持dataability://的路径前缀,用于访问通过Data Ability提供的视频路径,具体路径信息详见[Data Ability说明](../../ability/fa-dataability.md)。 | | src | string \| [Resource](../../ui/ts-types.md) | 否 | - | 视频播放源的路径,支持本地视频路径和网络路径。<br>支持在resources下面的video或rawfile文件夹里放置媒体资源。<br>支持dataability://的路径前缀,用于访问通过Data Ability提供的视频路径,具体路径信息详见[Data Ability说明](../../ability/fa-dataability.md)。 |
| currentProgressRate | number&nbsp;\|&nbsp;PlaybackSpeed<sup>8+</sup> | 否 | 1.0&nbsp;\|&nbsp;PlaybackSpeed.<br>Speed_Forward_1_00_X | 视频播放倍速。<br/>>&nbsp;&nbsp;**说明:**<br/>>&nbsp;number取值仅支持:0.75,1.0,1.25,1.75,2.0。<br/> | | currentProgressRate | number&nbsp;\|&nbsp;PlaybackSpeed<sup>8+</sup> | 否 | 1.0&nbsp;\|&nbsp;PlaybackSpeed.<br>Speed_Forward_1_00_X | 视频播放倍速。<br/>>&nbsp;&nbsp;**说明:**<br/>>&nbsp;number取值仅支持:0.75,1.0,1.25,1.75,2.0。<br/> |
| previewUri | string&nbsp;\|&nbsp;PixelMap<sup>8+</sup>&nbsp;\|&nbsp;[Resource](../../ui/ts-types.md) | 否 | - | 预览图片的路径。 | | previewUri | string&nbsp;\|&nbsp;PixelMap<sup>8+</sup>&nbsp;\|&nbsp;[Resource](../../ui/ts-types.md) | 否 | - | 预览图片的路径。 |
...@@ -40,7 +40,7 @@ Video(value: VideoOptions) ...@@ -40,7 +40,7 @@ Video(value: VideoOptions)
- PlaybackSpeed<sup>8+</sup>类型接口说明 - PlaybackSpeed<sup>8+</sup>类型接口说明
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------------------- | --------- |
| Speed_Forward_0_75_X | 0.75倍速播放。 | | Speed_Forward_0_75_X | 0.75倍速播放。 |
| Speed_Forward_1_00_X | 1倍速播放。 | | Speed_Forward_1_00_X | 1倍速播放。 |
| Speed_Forward_1_25_X | 1.25倍速播放。 | | Speed_Forward_1_25_X | 1.25倍速播放。 |
...@@ -51,7 +51,7 @@ Video(value: VideoOptions) ...@@ -51,7 +51,7 @@ Video(value: VideoOptions)
## 属性 ## 属性
| 名称 | 参数类型 | 默认值 | 描述 | | 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- | | --------- | ---------------------------------------- | ----- | --------------- |
| muted | boolean | false | 是否静音。 | | muted | boolean | false | 是否静音。 |
| autoPlay | boolean | false | 是否自动播放。 | | autoPlay | boolean | false | 是否自动播放。 |
| controls | boolean | true | 控制视频播放的控制栏是否显示。 | | controls | boolean | true | 控制视频播放的控制栏是否显示。 |
...@@ -62,7 +62,7 @@ Video(value: VideoOptions) ...@@ -62,7 +62,7 @@ Video(value: VideoOptions)
## 事件 ## 事件
| 名称 | 功能描述 | | 名称 | 功能描述 |
| -------- | -------- | | ---------------------------------------- | ---------------------------------------- |
| onStart()&nbsp;=&gt;&nbsp;void | 播放时触发该事件。 | | onStart()&nbsp;=&gt;&nbsp;void | 播放时触发该事件。 |
| onPause()&nbsp;=&gt;&nbsp;void | 暂停时触发该事件。 | | onPause()&nbsp;=&gt;&nbsp;void | 暂停时触发该事件。 |
| onFinish()&nbsp;=&gt;&nbsp;void | 播放结束时触发该事件。 | | onFinish()&nbsp;=&gt;&nbsp;void | 播放结束时触发该事件。 |
...@@ -111,7 +111,7 @@ setCurrentTime(value: number) ...@@ -111,7 +111,7 @@ setCurrentTime(value: number)
- 参数 - 参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ---- | --------- |
| value | number | 是 | - | 视频播放进度位置。 | | value | number | 是 | - | 视频播放进度位置。 |
### requestFullscreen ### requestFullscreen
...@@ -122,7 +122,7 @@ requestFullscreen(value: boolean) ...@@ -122,7 +122,7 @@ requestFullscreen(value: boolean)
- 参数 - 参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ----- | ------- |
| value | number | 是 | false | 是否全屏播放。 | | value | number | 是 | false | 是否全屏播放。 |
### exitFullscreen ### exitFullscreen
...@@ -139,13 +139,13 @@ setCurrentTime(value: number, seekMode: SeekMode) ...@@ -139,13 +139,13 @@ setCurrentTime(value: number, seekMode: SeekMode)
- 参数 - 参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | ---- | ---- | --------- |
| value | number | 是 | - | 视频播放进度位置。 | | value | number | 是 | - | 视频播放进度位置。 |
| seekMode | SeekMode | 是 | - | 跳转模式。 | | seekMode | SeekMode | 是 | - | 跳转模式。 |
- SeekMode<sup>8+</sup>类型接口说明 - SeekMode<sup>8+</sup>类型接口说明
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ---------------- | -------------- |
| PreviousKeyframe | 跳转到前一个最近的关键帧。 | | PreviousKeyframe | 跳转到前一个最近的关键帧。 |
| NextKeyframe | 跳转到后一个最近的关键帧。 | | NextKeyframe | 跳转到后一个最近的关键帧。 |
| ClosestKeyframe | 跳转到最近的关键帧。 | | ClosestKeyframe | 跳转到最近的关键帧。 |
......
...@@ -12,37 +12,37 @@ ...@@ -12,37 +12,37 @@
## 事件 ## 事件
| 名称 | 支持冒泡 | 功能描述 | | 名称 | 支持冒泡 | 功能描述 |
| -------- | -------- | -------- | | ---------------------------------------- | ---- | --------------------------------- |
| onClick(callback:&nbsp;(event?:&nbsp;ClickEvent)&nbsp;=&gt;&nbsp;void) | 否 | 点击动作触发该方法调用,event参数见ClickEvent介绍。 | | onClick(callback:&nbsp;(event?:&nbsp;ClickEvent)&nbsp;=&gt;&nbsp;void) | 否 | 点击动作触发该方法调用,event参数见ClickEvent介绍。 |
### ClickEvent对象说明 ## ClickEvent对象说明
| 属性名称 | 类型 | 描述 | | 属性名称 | 类型 | 描述 |
| -------- | -------- | -------- | | ------------------- | -------------------------------- | ------------------- |
| screenX | number | 点击点相对于设备屏幕左边沿的X坐标。 | | screenX | number | 点击点相对于设备屏幕左边沿的X坐标。 |
| screenY | number | 点击点相对于设备屏幕上边沿的Y坐标。 | | screenY | number | 点击点相对于设备屏幕上边沿的Y坐标。 |
| x | number | 点击点相对于被点击元素左边沿的X坐标。 | | x | number | 点击点相对于被点击元素左边沿的X坐标。 |
| y | number | 点击点相对于被点击元素上边沿的Y坐标。 | | y | number | 点击点相对于被点击元素上边沿的Y坐标。 |
| target<sup>8+</sup> | EventTarget | 被点击元素对象。 | | target<sup>8+</sup> | [EventTarget](#eventtarget8对象说明) | 被点击元素对象。 |
| timestamp | number | 事件时间戳。 | | timestamp | number | 事件时间戳。 |
- EventTarget<sup>8+</sup>对象说明 ## EventTarget<sup>8+</sup>对象说明
| 名称 | 参数类型 | 描述 | | 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- | | ---- | ----------------- | ---------- |
| area | Area | 目标元素的区域信息。 | | area | [Area](Area8对象说明) | 目标元素的区域信息。 |
- Area<sup>8+</sup>对象说明 ## Area<sup>8+</sup>对象说明
| 属性名称 | 类型 | 描述 | | 属性名称 | 类型 | 描述 |
| -------- | -------- | -------- | | -------------- | -------------------------- | ------------------- |
| width | number | 目标元素的宽度,单位为vp。 | | width | number | 目标元素的宽度,单位为vp。 |
| height | number | 目标元素的高度,单位为vp。 | | height | number | 目标元素的高度,单位为vp。 |
| position | Position | 目标元素左上角相对父元素左上角的位置。 | | position | [Position](#position8对象说明) | 目标元素左上角相对父元素左上角的位置。 |
| globalPosition | Position | 目标元素左上角相对页面左上角的位置。 | | globalPosition | [Position](#position8对象说明) | 目标元素左上角相对页面左上角的位置。 |
- Position<sup>8+</sup>对象说明 ## Position<sup>8+</sup>对象说明
| 属性名称 | 参数类型 | 描述 | | 属性名称 | 参数类型 | 描述 |
| -------- | -------- | -------- | | ---- | ------ | ----------- |
| x | number | x轴坐标,单位为vp。 | | x | number | x轴坐标,单位为vp。 |
| y | number | y轴坐标,单位为vp。 | | y | number | y轴坐标,单位为vp。 |
## 示例 ## 示例
......
...@@ -6,28 +6,26 @@ ...@@ -6,28 +6,26 @@
## 事件 ## 事件
| 名称 | 支持冒泡 | 功能描述 | | 名称 | 支持冒泡 | 功能描述 |
| -------- | -------- | -------- | | ---------------------------------------- | ---- | ---------------------------------------- |
| onDragStart(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;&nbsp;[CustomBuilder](../../ui/ts-types.md)) | 否 | 第一次拖拽此事件绑定的组件时,触发回调。<br/>event:拖拽事件信息,包括拖拽点坐标。<br/>extraParams:拖拽事件额外信息,详见extraParam类型描述。<br/>返回值:当前跟手效果所拖拽的对象,用于显示拖拽时的提示组件。<br/>>&nbsp;&nbsp;**说明:**<br/>>&nbsp;-&nbsp;长按150毫秒(ms)可触发拖拽事件。<br/>>&nbsp;-&nbsp;优先级:长按手势配置时间小于等于150毫秒(ms)时,长按手势优先触发,否则拖拽事件优先触发。 | | onDragStart(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;&nbsp;[CustomBuilder](../../ui/ts-types.md)) | 否 | 第一次拖拽此事件绑定的组件时,触发回调。<br/>- event:拖拽事件信息,包括拖拽点坐标。<br/>- extraParams:拖拽事件额外信息,详见extraParam类型描述。<br/>返回值:当前跟手效果所拖拽的对象,用于显示拖拽时的提示组件。<br/>长按150毫秒(ms)可触发拖拽事件。优先级:长按手势配置时间小于等于150毫秒(ms)时,长按手势优先触发,否则拖拽事件优先触发。 |
| onDragEnter(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 否 | 拖拽进入组件范围内时,触发回调。<br/>event:拖拽事件信息,包括拖拽点坐标。<br/>extraParams:拖拽事件额外信息,详见extraParam类型描述。<br/>>&nbsp;&nbsp;**说明:**<br/>>&nbsp;当监听了onDrop事件时,此事件才有效。 | | onDragEnter(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 否 | 拖拽进入组件范围内时,触发回调。<br/>- event:拖拽事件信息,包括拖拽点坐标。<br/>- extraParams:拖拽事件额外信息,详见extraParam类型描述。<br/>当监听了onDrop事件时,此事件才有效。 |
| onDragMove(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 否 | 拖拽在组件范围内移动时,触发回调。<br/>event:拖拽事件信息,包括拖拽点坐标。<br/>extraParams:拖拽事件额外信息,详见extraParam类型描述。<br/>>&nbsp;&nbsp;**说明:**<br/>>&nbsp;当监听了onDrop事件时,此事件才有效。 | | onDragMove(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 否 | 拖拽在组件范围内移动时,触发回调。<br/>- event:拖拽事件信息,包括拖拽点坐标。<br/>- extraParams:拖拽事件额外信息,详见extraParam类型描述。<br/>当监听了onDrop事件时,此事件才有效。 |
| onDragLeave(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 否 | 拖拽离开组件范围内时,触发回调。<br/>event:拖拽事件信息,包括拖拽点坐标。<br/>extraParams:拖拽事件额外信息,详见extraParam类型描述。<br/>>&nbsp;&nbsp;**说明:**<br/>>&nbsp;当监听了onDrop事件时,此事件才有效。 | | onDragLeave(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 否 | 拖拽离开组件范围内时,触发回调。<br/>- event:拖拽事件信息,包括拖拽点坐标。<br/>- extraParams:拖拽事件额外信息,详见extraParam类型描述。<br/>当监听了onDrop事件时,此事件才有效。 |
| onDrop(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 否 | 绑定此事件的组件可作为拖拽释放目标,当在本组件范围内停止拖拽行为时,触发回调。<br/>event:拖拽事件信息,包括拖拽点坐标。<br/>extraParams:拖拽事件额外信息,详见extraParam类型描述。 | | onDrop(callback:&nbsp;(event:&nbsp;DragEvent,&nbsp;extraParams?:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 否 | 绑定此事件的组件可作为拖拽释放目标,当在本组件范围内停止拖拽行为时,触发回调。<br/>- event:拖拽事件信息,包括拖拽点坐标。<br/>- extraParams:拖拽事件额外信息,详见extraParam类型描述。 |
- extraParam说明<br> - extraParam说明<br>
用于返回组件在拖拽中需要用到的额外信息。 用于返回组件在拖拽中需要用到的额外信息。
extraParam是Json对象转换的string字符串,可以通过Json.parse转换的Json对象获取如下属性。 extraParam是Json对象转换的string字符串,可以通过Json.parse转换的Json对象获取如下属性。
| 属性名称 | 属性类型 | 描述 | | 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- | | ------------- | ------ | ---------------------------------------- |
| selectedIndex | number | 当拖拽事件设在父容器的子元素时,selectedIndex表示当前被拖拽子元素是父容器第selectedIndex个子元素,selectedIndex从0开始。<br/>>&nbsp;&nbsp;**说明:**<br/>>&nbsp;仅在ListItem组件中生效。 | | selectedIndex | number | 当拖拽事件设在父容器的子元素时,selectedIndex表示当前被拖拽子元素是父容器第selectedIndex个子元素,selectedIndex从0开始。<br/>仅在ListItem组件中生效。 |
| insertIndex | number | 当前拖拽元素在List组件中放下时,insertIndex表示被拖拽元素插入该组件的第insertIndex个位置,insertIndex从0开始。<br/>>&nbsp;&nbsp;**说明:**<br/>>&nbsp;仅在List组件的拖拽事件中生效。 | | insertIndex | number | 当前拖拽元素在List组件中放下时,insertIndex表示被拖拽元素插入该组件的第insertIndex个位置,insertIndex从0开始。<br/>仅在List组件的拖拽事件中生效。 |
### DragEvent对象说明 ### DragEvent对象说明
- 接口 | 名称 | 返回值类型 | 功能描述 |
| 名称 | 返回值类型 | 功能描述 | | ------ | ------ | ---------------- |
| -------- | -------- | -------- | | getX() | number | 当前拖拽点x轴坐标,单位为vp。 |
| getX() | number | 当前拖拽点x轴坐标,单位为vp。 | | getY() | number | 当前拖拽点y轴坐标,单位为vp。 |
| getY() | number | 当前拖拽点y轴坐标,单位为vp。 |
## 示例 ## 示例
......
...@@ -12,19 +12,19 @@ ...@@ -12,19 +12,19 @@
## 事件 ## 事件
| 名称 | 支持冒泡 | 功能描述 | | 名称 | 支持冒泡 | 功能描述 |
| -------- | -------- | -------- | | ---------------------------------------- | ---- | ---------------------------------------- |
| onKeyEvent(event:&nbsp;(event?:&nbsp;KeyEvent)&nbsp;=&gt;&nbsp;void) | 是 | 按键动作触发该方法调用,event参数见[KeyEvent](#keyevent对象说明)介绍。 | | onKeyEvent(event:&nbsp;(event?:&nbsp;KeyEvent)&nbsp;=&gt;&nbsp;void) | 是 | 按键动作触发该方法调用,event参数见[KeyEvent](#keyevent对象说明)介绍。 |
### KeyEvent对象说明 ## KeyEvent对象说明
- 属性 - 属性
| 属性名称 | 类型 | 描述 | | 属性名称 | 类型 | 描述 |
| -------- | -------- | -------- | | --------- | --------------------------- | -------------------------- |
| type | KeyType | 按键的类型。 | | type | [KeyType](#keytype枚举说明) | 按键的类型。 |
| keyCode | number | 按键的键码。 | | keyCode | number | 按键的键码。 |
| keyText | string | 按键的键值。 | | keyText | string | 按键的键值。 |
| keySource | KeySource | 触发当前按键的输入设备类型。 | | keySource | [KeySource](#keysource枚举说明) | 触发当前按键的输入设备类型。 |
| deviceId | number | 触发当前按键的输入设备ID。 | | deviceId | number | 触发当前按键的输入设备ID。 |
| metaKey | number | 按键发生时元键的状态,1表示按压态,0表示未按压态。 | | metaKey | number | 按键发生时元键的状态,1表示按压态,0表示未按压态。 |
| timestamp | number | 按键发生时的时间戳。 | | timestamp | number | 按键发生时的时间戳。 |
...@@ -32,32 +32,32 @@ ...@@ -32,32 +32,32 @@
- 接口 - 接口
| 接口名称 | 功能描述 | | 接口名称 | 功能描述 |
| -------- | -------- | | ---------------------------- | --------- |
| stopPropagation():&nbsp;void | 阻塞事件冒泡传递。 | | stopPropagation():&nbsp;void | 阻塞事件冒泡传递。 |
- KeyType枚举说明 ## KeyType枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ---- | ----- |
| Down | 按键按下。 | | Down | 按键按下。 |
| Up | 按键松开。 | | Up | 按键松开。 |
- KeySource枚举说明 ## KeySource枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----------------------- | ---------- |
| Unknown | 输入设备类型未知。 | | Unknown | 输入设备类型未知。 |
| Keyboard | 输入设备类型为键盘。 | | [KeyCode](#常用keycode说明) | 输入设备类型为键盘。 |
- 常用KeyCode说明 ## 常用KeyCode说明
| 数值 | 行为 | 物理按键 | | 数值 | 行为 | 物理按键 |
| -------- | -------- | -------- | | ---- | ---- | ---------- |
| 19 | 上 | 向上方向键。 | | 19 | 上 | 向上方向键。 |
| 20 | 下 | 向下方向键。 | | 20 | 下 | 向下方向键。 |
| 21 | 左 | 向左方向键。 | | 21 | 左 | 向左方向键。 |
| 22 | 右 | 向右方向键。 | | 22 | 右 | 向右方向键。 |
| 23 | 确定 | 遥控器的确认键。 | | 23 | 确定 | 遥控器的确认键。 |
| 66 | 确定 | 键盘的回车键。 | | 66 | 确定 | 键盘的回车键。 |
| 160 | 确定 | 键盘的小键盘回车键。 | | 160 | 确定 | 键盘的小键盘回车键。 |
## 示例 ## 示例
......
...@@ -16,14 +16,14 @@ ...@@ -16,14 +16,14 @@
| onTouch(callback:&nbsp;(event?:&nbsp;TouchEvent)&nbsp;=&gt;&nbsp;void) | 是 | 触摸动作触发该方法调用,event参数见[TouchEvent](#touchevent对象说明)介绍。 | | onTouch(callback:&nbsp;(event?:&nbsp;TouchEvent)&nbsp;=&gt;&nbsp;void) | 是 | 触摸动作触发该方法调用,event参数见[TouchEvent](#touchevent对象说明)介绍。 |
### TouchEvent对象说明 ## TouchEvent对象说明
- 属性 - 属性
| 属性名称 | 类型 | 描述 | | 属性名称 | 类型 | 描述 |
| ------------------- | ---------------------------------------- | ------------ | | ------------------- | ---------------------------------------- | ------------ |
| type | TouchType | 触摸事件的类型。 | | type | TouchType | 触摸事件的类型。 |
| touches | ArrayTouchObject&gt; | 全部手指信息。 | | touches | Array&lt;[TouchObject](touchobject对象说明)&gt; | 全部手指信息。 |
| changedTouches | ArrayTouchObject&gt; | 当前发生变化的手指信息。 | | changedTouches | Array&lt;[TouchObject](touchobject对象说明)&gt; | 当前发生变化的手指信息。 |
| timestamp | number | 事件时间戳。 | | timestamp | number | 事件时间戳。 |
| target<sup>8+</sup> | [EventTarget](ts-universal-events-click.md) | 被触摸元素对象。 | | target<sup>8+</sup> | [EventTarget](ts-universal-events-click.md) | 被触摸元素对象。 |
...@@ -34,24 +34,24 @@ ...@@ -34,24 +34,24 @@
| stopPropagation():void | 阻塞事件冒泡。 | | stopPropagation():void | 阻塞事件冒泡。 |
- TouchObject对象说明 ## TouchObject对象说明
| 属性名称 | 类型 | 描述 | | 属性名称 | 类型 | 描述 |
| ------- | --------- | ------------------- | | ------- | --------------------------- | ------------------- |
| type | TouchType | 触摸事件的类型。 | | type | [TouchType](#touchtype枚举说明) | 触摸事件的类型。 |
| id | number | 手指唯一标识符。 | | id | number | 手指唯一标识符。 |
| screenX | number | 触摸点相对于设备屏幕左边沿的X坐标。 | | screenX | number | 触摸点相对于设备屏幕左边沿的X坐标。 |
| screenY | number | 触摸点相对于设备屏幕上边沿的Y坐标。 | | screenY | number | 触摸点相对于设备屏幕上边沿的Y坐标。 |
| x | number | 触摸点相对于被触摸元素左边沿的X坐标。 | | x | number | 触摸点相对于被触摸元素左边沿的X坐标。 |
| y | number | 触摸点相对于被触摸元素上边沿的Y坐标。 | | y | number | 触摸点相对于被触摸元素上边沿的Y坐标。 |
- TouchType枚举说明 ## TouchType枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| ------ | --------------- | | ------ | --------------- |
| Down | 手指按下时触发。 | | Down | 手指按下时触发。 |
| Up | 手指抬起时触发。 | | Up | 手指抬起时触发。 |
| Move | 手指按压态在屏幕上移动时触发。 | | Move | 手指按压态在屏幕上移动时触发。 |
| Cancel | 触摸事件取消时触发。 | | Cancel | 触摸事件取消时触发。 |
## 示例 ## 示例
......
...@@ -12,39 +12,39 @@ ...@@ -12,39 +12,39 @@
## 事件 ## 事件
| 名称 | 支持冒泡 | 描述 | | 名称 | 支持冒泡 | 描述 |
| -------- | -------- | -------- | | ---------------------------------------- | ---- | ---------------------------------------- |
| onHover(callback:&nbsp;(isHover:&nbsp;boolean)&nbsp;=&gt;&nbsp;void) | 否 | 鼠标进入或退出组件时触发该回调。<br/>isHover:表示鼠标是否悬浮在组件上,鼠标进入时为true,&nbsp;退出时为false。 | | onHover(callback:&nbsp;(isHover:&nbsp;boolean)&nbsp;=&gt;&nbsp;void) | 否 | 鼠标进入或退出组件时触发该回调。<br/>isHover:表示鼠标是否悬浮在组件上,鼠标进入时为true,&nbsp;退出时为false。 |
| onMouse(callback:&nbsp;(event?:&nbsp;MouseEvent)&nbsp;=&gt;&nbsp;void) | 是 | 当前组件被鼠标按键点击时或者鼠标在组件上移动时,触发该回调,event参数包含触发事件时的时间戳、鼠标按键、动作、点击触点在整个屏幕上的坐标和点击触点相对于当前组件的坐标。 | | onMouse(callback:&nbsp;(event?:&nbsp;MouseEvent)&nbsp;=&gt;&nbsp;void) | 是 | 当前组件被鼠标按键点击时或者鼠标在组件上移动时,触发该回调,event参数包含触发事件时的时间戳、鼠标按键、动作、点击触点在整个屏幕上的坐标和点击触点相对于当前组件的坐标。 |
### MouseEvent对象说明 ## MouseEvent对象说明
| 属性名称 | 属性类型 | 描述 | | 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- | | --------- | ------------------------------- | -------------------- |
| timestamp | number | 触发事件时的时间戳。 | | timestamp | number | 触发事件时的时间戳。 |
| screenX | number | 点击触点相对于屏幕左上角的x轴坐标。 | | screenX | number | 点击触点相对于屏幕左上角的x轴坐标。 |
| screenY | number | 点击触点相对于屏幕左上角的y轴坐标。 | | screenY | number | 点击触点相对于屏幕左上角的y轴坐标。 |
| x | number | 点击触点相对于当前组件左上角的x轴坐标。 | | x | number | 点击触点相对于当前组件左上角的x轴坐标。 |
| y | number | 点击触点相对于当前组件左上角的y轴坐标。 | | y | number | 点击触点相对于当前组件左上角的y轴坐标。 |
| button | MouseButton | 鼠标按键。 | | button | [MouseButton](#mousebutton类型说明) | 鼠标按键。 |
| action | MouseAction | 事件动作。 | | action | [MouseAction](#mouseaction类型说明) | 事件动作。 |
- MouseButton类型说明 ## MouseButton类型说明
| 属性名称 | 属性类型 | 描述 | | 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- | | ------- | ------ | -------- |
| Left | number | 鼠标左键。 | | Left | number | 鼠标左键。 |
| Right | number | 鼠标右键。 | | Right | number | 鼠标右键。 |
| Middle | number | 鼠标中键。 | | Middle | number | 鼠标中键。 |
| Back | number | 鼠标左侧后退键。 | | Back | number | 鼠标左侧后退键。 |
| Forward | number | 鼠标左侧前进键。 | | Forward | number | 鼠标左侧前进键。 |
| None | number | 无按键。 | | None | number | 无按键。 |
- MouseAction类型说明 ## MouseAction类型说明
| 属性名称 | 属性类型 | 描述 | | 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- | | ------- | ------ | ------- |
| Press | number | 鼠标按键按下。 | | Press | number | 鼠标按键按下。 |
| Release | number | 鼠标按键松开。 | | Release | number | 鼠标按键松开。 |
| Move | number | 鼠标移动。 | | Move | number | 鼠标移动。 |
## 示例 ## 示例
......
...@@ -7,5 +7,5 @@ ...@@ -7,5 +7,5 @@
延迟任务调度 延迟任务调度
- [延迟任务调度概述](work-scheduler-overview.md) - [延迟任务调度概述](work-scheduler-overview.md)
- [延迟任务调度开发指导](work-scheduler-dev-guide.md) - [延迟任务调度开发指导](work-scheduler-dev-guide.md)
\ No newline at end of file \ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册