Skip to content

Commit

Permalink
chore(interaction): add action to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dxq613 authored and simaQ committed Mar 16, 2020
1 parent 2e042d8 commit fdf485c
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 9 deletions.
25 changes: 24 additions & 1 deletion docs/manual/tutorial/interaction.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -604,6 +604,7 @@ registerInteraction('brush-visible', {
- element-highlight
- element-single-highlight
- element-range-highlight
- element-sibling-highlight
- element-filter
- element-sibling-filter
- element-link-by-color
Expand Down Expand Up @@ -669,6 +670,21 @@ Element 的 Action 可以响应的触发源:
- toggle() 设置/取消当前触发事件相关元素的 highlight
- reset() 取消当前触发事件相关元素的 highlight

### element-range-highlight
用于设置和取消图表元素的 highlight ,允许框选 highlight 有以下方法:
- start() 开始框选
- end() 结束框选
- highlight() 高亮框选内部的元素
- clear() 清理框选的元素

`注意`:如果事件由 mask 触发,则可以直接调用 highlight,而不需要 start 和 end

### element-sibling-highlight

图表元素高亮时,对应的其他 view 的图形也同时高亮,这个 Action 是从 element-range-highlight 扩展出来的,可以配合 element-range-highlight 一起使用:
- highlight() 设置当前触发事件相关元素对应的其他 View 上的元素的 highlight
- clear() 取消相关元素的 highlight

### element-filter

图表元素的过滤,支持来自图例(分类和连续)、坐标轴文本的触发,有以下方法:
Expand Down Expand Up @@ -848,6 +864,8 @@ registerInteraction('element-brush', {
- rect-mask
- circle-mask
- path-mask
- button 按钮
- reset-button 恢复按钮

### active-region

Expand Down Expand Up @@ -876,7 +894,7 @@ registerInteraction('element-brush', {
- hide() 隐藏遮罩层
- end() 结束框选

### circle-mask
### path-mask

在画布上进行框选,在多个点上形成 path,有以下方法

Expand All @@ -886,6 +904,11 @@ registerInteraction('element-brush', {
- hide() 隐藏遮罩层
- end() 结束框选

### reset-button
在画布右上角出现一个恢复按钮,按钮图形上有 name: 'reset-button',仅有两个方法:
- show() 显示
- hide() 隐藏

## 更多

本文中仅介绍了如何使用交互,而所有交互都是通过交互语法搭配而成的,需要自定义交互的用户可以参考 [交互语法](../concepts/interaction)  和 [自定义交互](../developer/registerinteraction)
32 changes: 24 additions & 8 deletions docs/manual/tutorial/interaction.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -670,18 +670,27 @@ Element 的 Action 可以响应的触发源:
- toggle() 设置/取消当前触发事件相关元素的 highlight
- reset() 取消当前触发事件相关元素的 highlight

### element-filter

图表元素的过滤,支持来自图例(分类和连续)、坐标轴文本的触发,有以下方法:
### element-range-highlight
用于设置和取消图表元素的 highlight ,允许框选 highlight 有以下方法:
- start() 开始框选
- end() 结束框选
- highlight() 高亮框选内部的元素
- clear() 清理框选的元素

- filter() 过滤
- reset() 取消过滤
`注意`:如果事件由 mask 触发,则可以直接调用 highlight,而不需要 start 和 end

### element-sibling-highlight
图表元素高亮时,对应的其他 view 的图形也同时高亮:

图表元素高亮时,对应的其他 view 的图形也同时高亮,这个 Action 是从 element-range-highlight 扩展出来的,可以配合 element-range-highlight 一起使用:
- highlight() 设置当前触发事件相关元素对应的其他 View 上的元素的 highlight
- clear() 取消相关元素的 highlight

### element-filter

图表元素的过滤,支持来自图例(分类和连续)、坐标轴文本的触发,有以下方法:

- filter() 过滤
- reset() 取消过滤
### element-link-by-color

用于连接相同颜色的图表元素,一般用于层叠柱状图,有以下方法:
Expand Down Expand Up @@ -847,13 +856,15 @@ registerInteraction('element-brush', {

## 辅助交互的 Action

在交互过程中辅助出现的图形,目前仅实现了两种
在交互过程中辅助出现的图形,目前仅实现了几种常见的

- active-region
- mask 遮罩层,内置了几种 mask
- rect-mask
- circle-mask
- path-mask
- button 按钮
- reset-button 恢复按钮

### active-region

Expand Down Expand Up @@ -882,7 +893,7 @@ registerInteraction('element-brush', {
- hide() 隐藏遮罩层
- end() 结束框选

### circle-mask
### path-mask

在画布上进行框选,在多个点上形成 path,有以下方法

Expand All @@ -892,6 +903,11 @@ registerInteraction('element-brush', {
- hide() 隐藏遮罩层
- end() 结束框选

### reset-button
在画布右上角出现一个恢复按钮,按钮图形上有 name: 'reset-button',仅有两个方法:
- show() 显示
- hide() 隐藏

## 更多

本文中仅介绍了如何使用交互,而所有交互都是通过交互语法搭配而成的,需要自定义交互的用户可以参考 [交互语法](../concepts/interaction)  和 [自定义交互](../developer/registerinteraction)

0 comments on commit fdf485c

Please sign in to comment.