Skip to content

Commit

Permalink
docs: 更新common英文文档 (#1655)
Browse files Browse the repository at this point in the history 
* docs: 更新common文档中的英文标题

* docs: 更新common英文文档
  • Loading branch information
@DarrenPei
DarrenPei committed Sep 28, 2020
1 parent 13e2a65 commit 8952cc7
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 49 deletions.
14 changes: 7 additions & 7 deletions docs/common/chart-methods.en.md
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
#### render() 📌

<description>**必选** </description>
<description>**required** </description>

功能描述：渲染图表。
Description: Render the chart.

默认配置：`无`
Default: `none`

#### update()

<description>**可选** </description>
<description>**optional** </description>

功能描述：更新图表配置项，配置覆盖，不会做差异比对。
Description: Update chart configuration and overwrite it without comparing difference.

默认配置：`无`
Default: `none`

使用示例：
Example：

```ts
plot.update({
Expand Down
38 changes: 19 additions & 19 deletions docs/common/chart-options.en.md
View file
Original file line number Diff line number Diff line change
@@ -1,51 +1,51 @@
#### width

<description>**可选** _number_</description>
<description>**optional** _number_</description>

功能描述：设置图表宽度。
Description: Set the width of the chart.

默认配置：`400`
Default: `400`

#### height

<description>**可选** _number_</description>
<description>**optional** _number_</description>

功能描述：设置图表高度。
Description: Set the height of the chart.

默认配置：`400`
Default: `400`

#### autoFit

<description>**可选** _boolean_</description>
<description>**optional** _boolean_</description>

功能描述：图表是否自适应容器宽高。当 `autoFit` 设置为 true 时，`width` 和 `height` 的设置将失效。
Description: Whether the chart automatically adjusts to fit the container. If it is set to `true`, `width` and `height` configuration would fail.

默认配置：`true`
Default: `true`

#### padding

<description>**可选** _number[] | number | 'auto'_</description>
<description>**optional** _number[] | number | 'auto'_</description>

功能描述： 画布的 `padding` 值，或者开启 `auto`。
Description: Set `padding` value of the canvas. You can also use `auto`.

#### appendPadding

<description>**可选** _number[] | number_</description>
<description>**optional** _number[] | number_</description>

功能描述： 额外增加的 `appendPadding` 值。
Description: Extra `appendPadding` value.

#### renderer

<description>**可选** _string_</description>
<description>**optional** _string_</description>

功能描述: 设置图表渲染方式为 `canvas` 或 `svg`。
Description: Set the render way to `canvas` or `svg`.

默认配置： `canvas`
Default: `canvas`

#### pixelRatio

<description>**可选** _number_</description>
<description>**optional** _number_</description>

功能描述: 设置图表渲染的像素比。
Description: Set the pixel ratio of the chart.

默认配置： `window.devicePixelRatio`
Default: `window.devicePixelRatio`
14 changes: 7 additions & 7 deletions docs/common/color.en.md
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
#### color

**可选**, _string | string[] | Function_
**optional**, _string | string[] | Function_

功能描述： 指定点的颜色。如没有配置 colorField，指定一个单值即可。对 colorFiled 进行了配置的情况下，即可以指定一系列色值，也可以通过回调函数的方法根据对应数值进行设置。
Description: Configure the color. If there is no colorField configured, set one single color. Otherwise you can set a series of colors, or you can use callback function.

默认配置：采用 theme 中的色板。
Default: The color board of the theme.

```ts
// 设置单一颜色
// set one single color
{
color: '#a8ddb5'
}
// 设置多色
// set a series of colors
{
colorField: 'type', // 部分图表使用 seriesField
colorField: 'type', // or seriesField in some cases
color: ['#d62728', '#2ca02c', '#000000'],
}
// Function
{
colorField: 'type', // 部分图表使用 seriesField
colorField: 'type', // or seriesField in some cases
color: (type) => {
if(type === 'male'){
return 'red';
Expand Down
32 changes: 16 additions & 16 deletions docs/common/shape-style.en.md
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
<!--图形样式-->
<!--shape style-->

| 属性名 | 类型 | 介绍 |
| Attr | Type | Description |
| ------------- | --------------- | ------------------------------------------------------------------------------------------------------------ |
| fill | string | 图形的填充色 |
| fillOpacity | number | 图形的填充透明度 |
| stroke | string | 图形的描边 |
| lineWidth | number | 图形描边的宽度 |
| lineDash | [number,number] | 描边的虚线配置，第一个值为虚线每个分段的长度，第二个值为分段间隔的距离。lineDash 设为[0,0]的效果为没有描边。 |
| lineOpacity | number | 描边透明度 |
| opacity | number | 图形的整体透明度 |
| shadowColor | string | 图形阴影颜色 |
| strokeOpacity | number | 图形边框透明度 |
| shadowBlur | number | 图形阴影的高斯模糊系数 |
| shadowOffsetX | number | 设置阴影距图形的水平距离 |
| shadowOffsetY | number | 设置阴影距图形的垂直距离 |
| cursor | string | 鼠标样式。同 css 的鼠标样式，默认 'default'。 |
| fill | string | Fill color of the shape |
| fillOpacity | number | Fill opacity of the shape |
| stroke | string | Stroke color of the shape |
| lineWidth | number | The width of the stroke of the shape |
| lineDash | [number,number] | Configure dashed line stroke. The first parameter is the length of each segment, and the second parameter is the gap between segment. When lineDash is set to [0,0], there is no effect. |
| lineOpacity | number | Opacity of the stroke |
| opacity | number | Opacity of the shape |
| shadowColor | string | Shadow color of the shape |
| strokeOpacity | number | Stroke opacity of the shape |
| shadowBlur | number | Gaussian blur coefficient of the shadow |
| shadowOffsetX | number | Configure horizontal distance between shadow and shape |
| shadowOffsetY | number | Configure vertical distance between shadow and shape |
| cursor | string | Mouse style, same as the mouse style of CSS, default value : 'default' |

示例代码：
Example：

```ts
{
Expand Down

0 comments on commit 8952cc7

Please sign in to comment.