Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(tooltip): 更新 tooltip 关于 marker 的文档 #2439

Merged
merged 1 commit into from
Mar 18, 2021
Merged

docs(tooltip): 更新 tooltip 关于 marker 的文档 #2439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/components/tooltip.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ order: 3

#### Tooltip

<img src="https://gw.alipayobjects.com/zos/antfincdn/HjTKrPN%24j6/tooltip-intro.png" class="component-img" alt="tooltip" />
<img src="https://gw.alipayobjects.com/zos/antfincdn/qAwyqRLJXT/Tooltip%252520jieshao.png" class="component-img" alt="tooltip" />

#### Configurations (_TooltipCfg_)

Expand Down
2 changes: 1 addition & 1 deletion docs/api/components/tooltip.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ order: 3

#### Tooltip 组成

<img src="https://gw.alipayobjects.com/zos/antfincdn/HjTKrPN%24j6/tooltip-intro.png" class="component-img" alt="tooltip" />
<img src="https://gw.alipayobjects.com/zos/antfincdn/qAwyqRLJXT/Tooltip%252520jieshao.png" class="component-img" alt="tooltip" />

#### 配置项 (_TooltipCfg_)

Expand Down
4 changes: 2 additions & 2 deletions docs/common/marker.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
| 参数名 | 类型 | 默认值 | 描述 |
| ------- | ---------------------------- | ------ | -------------------------------- |
| symbol | _Marker_ \| _MarkerCallback_ | - | 配置图例 marker 的 symbol 形状 |
| style | ShapeAttrs | - | 图例项 marker 的配置项 |
| spacing | number | - | 图例项 marker 同后面 name 的间距 |
| style | _ShapeAttrs_ | - | 图例项 marker 的配置项 |
| spacing | _number_ | - | 图例项 marker 同后面 name 的间距 |

_Marker_ 为支持的标记类型有： _circle | square | line | diamond | triangle | triangle-down | hexagon | bowtie | cross | tick | plus | hyphen_；
_MarkerCallback_ 为 `(x: number, y: number, r: number) => PathCommand`；
4 changes: 2 additions & 2 deletions docs/common/tooltip.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,11 @@ Whether to render TooltipMarkers.

##### marker

<description>**optional** _object_</description>
<description>**optional** _ShapeAttrs_</description>

TooltipMarker style configuration.

`markdown:docs/common/marker.en.md`
Please refer to the style configuration [ShapeAttrs](/en/docs/api/graphic-style)

##### showContent

Expand Down
4 changes: 2 additions & 2 deletions docs/common/tooltip.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,11 @@ true 表示合并当前点对应的所有数据并展示，false 表示只展示

##### marker

<description>**可选** _object_</description>
<description>**可选** _ShapeAttrs_</description>

tooltipMarker 的样式配置。

`markdown:docs/common/marker.zh.md`
样式配置类型，详细可见: [ShapeAttrs](/zh/docs/api/graphic-style)

##### showContent

Expand Down