Skip to content

Commit

Permalink
docs: 添加 tooltip (#1452)
Browse files Browse the repository at this point in the history
* docs: 添加 tooltip

* fix: resolve conversation

* fix: resolve conversation

Co-authored-by: liufu.lf <liufu.lf@antfin.com>
  • Loading branch information
lxfu1 and liufu.lf authored Aug 18, 2020
1 parent 32ab284 commit 0dda527
Show file tree
Hide file tree
Showing 10 changed files with 588 additions and 5 deletions.
2 changes: 0 additions & 2 deletions docs/common/chart-options.zh.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
<tag color="#87d068" text="我是引用"></tag>

#### width

<description>**可选** _number_</description>
Expand Down
35 changes: 35 additions & 0 deletions docs/common/line-style.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!--线条样式-->

| 属性名 | 类型 | 介绍 |
| ------------- | --------------- | ------------------------------------------------------------------------------------------------------ |
| stroke | string | 线的颜色 |
| lineWidth | number | 线宽 |
| lineDash | [number,number] | 虚线配置,第一个值为虚线每个分段的长度,第二个值为分段间隔的距离。lineDash 设为[0,0]的效果为没有描边。 |
| opacity | number | 透明度 |
| shadowColor | string | 阴影颜色 |
| shadowBlur | number | 高斯模糊系数 |
| shadowOffsetX | number | 设置阴影距图形的水平距离 |
| shadowOffsetY | number | 设置阴影距图形的垂直距离 |
| cursor | string | 鼠标样式。同 css 的鼠标样式,默认 'default'。 |

示例代码:

```js
xAxis: {
grid: {
line: {
style: {
stroke: 'black',
lineWidth: 2,
lineDash: [4, 5],
strokeOpacity: 0.7,
shadowColor: 'black',
shadowBlur: 10,
shadowOffsetX: 5,
shadowOffsetY: 5,
cursor: 'pointer'
}
}
}
}
```
35 changes: 35 additions & 0 deletions docs/common/line-style.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!--线条样式-->

| 属性名 | 类型 | 介绍 |
| ------------- | --------------- | ------------------------------------------------------------------------------------------------------ |
| stroke | string | 线的颜色 |
| lineWidth | number | 线宽 |
| lineDash | [number,number] | 虚线配置,第一个值为虚线每个分段的长度,第二个值为分段间隔的距离。lineDash 设为[0,0]的效果为没有描边。 |
| opacity | number | 透明度 |
| shadowColor | string | 阴影颜色 |
| shadowBlur | number | 高斯模糊系数 |
| shadowOffsetX | number | 设置阴影距图形的水平距离 |
| shadowOffsetY | number | 设置阴影距图形的垂直距离 |
| cursor | string | 鼠标样式。同 css 的鼠标样式,默认 'default'。 |

示例代码:

```js
xAxis: {
grid: {
line: {
style: {
stroke: 'black',
lineWidth: 2,
lineDash: [4, 5],
strokeOpacity: 0.7,
shadowColor: 'black',
shadowBlur: 10,
shadowOffsetX: 5,
shadowOffsetY: 5,
cursor: 'pointer'
}
}
}
}
```
34 changes: 34 additions & 0 deletions docs/common/shape-style.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!--图形样式-->

| 属性名 | 类型 | 介绍 |
| ------------- | --------------- | ------------------------------------------------------------------------------------------------------------ |
| fill | string | 图形的填充色 |
| fillOpacity | number | 图形的填充透明度 |
| stroke | string | 图形的描边 |
| lineWidth | number | 图形描边的宽度 |
| lineDash | [number,number] | 描边的虚线配置,第一个值为虚线每个分段的长度,第二个值为分段间隔的距离。lineDash 设为[0,0]的效果为没有描边。 |
| lineOpacity | number | 描边透明度 |
| opacity | number | 图形的整体透明度 |
| shadowColor | string | 图形阴影颜色 |
| shadowBlur | number | 图形阴影的高斯模糊系数 |
| shadowOffsetX | number | 设置阴影距图形的水平距离 |
| shadowOffsetY | number | 设置阴影距图形的垂直距离 |
| cursor | string | 鼠标样式。同 css 的鼠标样式,默认 'default'。 |

示例代码:

```js
pointStyle: {
fill: 'red',
fillOpacity: 0.5,
stroke: 'black',
lineWidth: 1,
lineDash: [4, 5],
strokeOpacity: 0.7,
shadowColor: 'black',
shadowBlur: 10,
shadowOffsetX: 5,
shadowOffsetY: 5,
cursor: 'pointer'
}
```
34 changes: 34 additions & 0 deletions docs/common/shape-style.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!--图形样式-->

| 属性名 | 类型 | 介绍 |
| ------------- | --------------- | ------------------------------------------------------------------------------------------------------------ |
| fill | string | 图形的填充色 |
| fillOpacity | number | 图形的填充透明度 |
| stroke | string | 图形的描边 |
| lineWidth | number | 图形描边的宽度 |
| lineDash | [number,number] | 描边的虚线配置,第一个值为虚线每个分段的长度,第二个值为分段间隔的距离。lineDash 设为[0,0]的效果为没有描边。 |
| lineOpacity | number | 描边透明度 |
| opacity | number | 图形的整体透明度 |
| shadowColor | string | 图形阴影颜色 |
| shadowBlur | number | 图形阴影的高斯模糊系数 |
| shadowOffsetX | number | 设置阴影距图形的水平距离 |
| shadowOffsetY | number | 设置阴影距图形的垂直距离 |
| cursor | string | 鼠标样式。同 css 的鼠标样式,默认 'default'。 |

示例代码:

```js
pointStyle: {
fill: 'red',
fillOpacity: 0.5,
stroke: 'black',
lineWidth: 1,
lineDash: [4, 5],
strokeOpacity: 0.7,
shadowColor: 'black',
shadowBlur: 10,
shadowOffsetX: 5,
shadowOffsetY: 5,
cursor: 'pointer'
}
```
36 changes: 36 additions & 0 deletions docs/common/text-style.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!--文本样式-->

| 属性名 | 类型 | 介绍 |
| ------------- | --------------- | ------------------------------------------------------------------------------------------------------------ |
| fontSize | number | 文字大小 |
| fontFamily | string | 文字字体 |
| fontWeight | number | 字体粗细 |
| lineHeight | number | 文字的行高 |
| textAlign | string | 设置文本内容的当前对齐方式, 支持的属性:`center` \| `end` \| `left` \| `right` \| `start`,默认值为`start` |
| fill | string | 文字的填充色 |
| fillOpacity | number | 文字的填充透明度 |
| stroke | string | 文字的描边 |
| lineWidth | number | 文字描边的宽度 |
| lineDash | [number,number] | 描边的虚线配置,第一个值为虚线每个分段的长度,第二个值为分段间隔的距离。lineDash 设为[0,0]的效果为没有描边。 |
| lineOpacity | number | 描边透明度 |
| opacity | number | 文字的整体透明度 |
| shadowColor | string | 文字阴影颜色 |
| shadowBlur | number | 文字阴影的高斯模糊系数 |
| shadowOffsetX | number | 设置阴影距文字的水平距离 |
| shadowOffsetY | number | 设置阴影距文字的垂直距离 |
| cursor | string | 鼠标样式。同 css 的鼠标样式,默认 'default'。 |

示例代码,以 label.style 配置为例:

```js
label: {
style:{
fontSize: 80,
fontWeight: 300,
textAlign: 'center',
textBaseline: 'middle',
shadowColor: 'white',
shadowBlur: 10,
}
}
```
36 changes: 36 additions & 0 deletions docs/common/text-style.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!--文本样式-->

| 属性名 | 类型 | 介绍 |
| ------------- | --------------- | ------------------------------------------------------------------------------------------------------------ |
| fontSize | number | 文字大小 |
| fontFamily | string | 文字字体 |
| fontWeight | number | 字体粗细 |
| lineHeight | number | 文字的行高 |
| textAlign | string | 设置文本内容的当前对齐方式, 支持的属性:`center` \| `end` \| `left` \| `right` \| `start`,默认值为`start` |
| fill | string | 文字的填充色 |
| fillOpacity | number | 文字的填充透明度 |
| stroke | string | 文字的描边 |
| lineWidth | number | 文字描边的宽度 |
| lineDash | [number,number] | 描边的虚线配置,第一个值为虚线每个分段的长度,第二个值为分段间隔的距离。lineDash 设为[0,0]的效果为没有描边。 |
| lineOpacity | number | 描边透明度 |
| opacity | number | 文字的整体透明度 |
| shadowColor | string | 文字阴影颜色 |
| shadowBlur | number | 文字阴影的高斯模糊系数 |
| shadowOffsetX | number | 设置阴影距文字的水平距离 |
| shadowOffsetY | number | 设置阴影距文字的垂直距离 |
| cursor | string | 鼠标样式。同 css 的鼠标样式,默认 'default'。 |

示例代码,以 label.style 配置为例:

```js
label: {
style:{
fontSize: 80,
fontWeight: 300,
textAlign: 'center',
textBaseline: 'middle',
shadowColor: 'white',
shadowBlur: 10,
}
}
```
Loading

0 comments on commit 0dda527

Please sign in to comment.