Skip to content

docs(dualbarmix): 修复双轴图的API文档-图形样式中的链接和国际化问题 #2531

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

Merged
merged 2 commits into from
May 2, 2021
Merged

docs(dualbarmix): 修复双轴图的API文档-图形样式中的链接和国际化问题 #2531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee264c2
docs(dualbarmix): 修复双轴图的API文档-图形样式中的链接和国际化问题
DawnLck Apr 29, 2021
fedbeca
docs(dualmixbar): 修改双轴图-API文档-链接的格式，并保持中英文一致
DawnLck Apr 29, 2021
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
30 changes: 15 additions & 15 deletions docs/api/plots/dual-axes.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,34 +63,34 @@ Specifies the respective configuration of the two axes in the form of "left axis
- Biaxial line chart: [Line, Line], reference [DEMO](/en/examples/dual-axes/dual-line)
- Column and Line Mixing Chart: [Column, Line], reference [DEMO](/en/examples/dual-axes/column-line)

你还可以通过配置 Line 或 Column 的相关配置（见下文），形成双轴多 Line([DEMO](/en/examples/dual-axes/dual-line#dual-multi-line)), 堆叠柱+Line([DEMO](/en/examples/dual-axes/stacked-column-line)), 分组柱+Line([DEMO](/en/examples/dual-axes/grouped-column-line))
You can also configure the related configuration of Line or Column (see below) to form a DualAxisLine([DEMO](/en/examples/dual-axes/dual-line#dual-multi-line)), StackingColumnLine([DEMO](/en/examples/dual-axes/stacked-column-line)), GroupColumnLine([DEMO](/en/examples/dual-axes/grouped-column-line))

The corresponding graph configuration of polyline is as follows:

| Properties | Type | Description | Default |
| ------------ | -------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------- |
| geometry | _string_ | Chart type, specified as 'line' | 'line' |
| seriesField | _string_ | Split the field, if there is a polyline, the specific use of the same[Line seriesfield](./line#seriesfield) |
| smooth | _boolean_ | Whether is smooth[Line smooth](./line#smooth) | false |
| connectNulls | _boolean_ | Whether to connect empty data[Line connectnulls](./line#connectnulls) | true |
| lineStyle | _StyleAttr \| Function_ | Line style[Line lineStyle](./line#linestyle) | |
| point | _pointStyle_ | Line data point graphic style[Line point](./line#point) | |
| label | _ContinueLegendLabelCfg_ | Line label [Line label](./line#label) |
| color | _string \| string[] \| Function_ | Specifies the color of the point[Line color](./line#color) |
| seriesField | _string_ | Split the field, if there is a polyline, the specific use of the same [Line seriesfield](/en/docs/api/plots/line#seriesfield) |
| smooth | _boolean_ | Whether is smooth [Line smooth](/en/docs/api/plots/line#smooth) | false |
| connectNulls | _boolean_ | Whether to connect empty data [Line connectnulls](/en/docs/api/plots/line#connectnulls) | true |
| lineStyle | _StyleAttr \| Function_ | Line style [Line lineStyle](/en/docs/api/plots/line#linestyle) | |
| point | _pointStyle_ | Line data point graphic style [Line point](/en/docs/api/plots/line#point) | |
| label | _ContinueLegendLabelCfg_ | Line label [Line label](/en/docs/api/plots/line#label) |
| color | _string \| string[] \| Function_ | Specifies the color of the point [Line color](/en/docs/api/plots/line#color) |

The graph corresponding to the column is configured as follows:

| Properties | Type | Description | Default |
| ---------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| geometry | _string_ | Chart type, specified as 'column' | |
| seriesField | _string_ | Split fields, same as GroupField and ColorField under the grouping bar chart, same as StackField and ColorField under the stacking bar chart, specificreference[Column seriesfield](./column#seriesfield) |
| isGroup | _boolean_ | Whether to group bar charts[Column isGroup](./column#isgroup) | false |
| isStack | _boolean_ | Whether to stack histograms[Column isStack](./column#isstack) | false |
| columnWidthRatio | _number_ | Histogram width ratio [0-1] [Column columnWidthRatio](./column#columnwidthratio) | |
| marginRatio | _number_ | The spacing between columns in a grouping [0-1] applies only to grouping histograms[Column marginRatio](./column#marginratio) | |
| columnStyle | _StyleAttr \| Function_ | Column style configuration[Column columnStyle](./column#columnstyle) | |
| label | _ContinueLegendLabelCfg_ | Column label [Column label](./column#label) |
| color | _string \| string[] \| Function_ | Specifies the color of the point[Line color](./column#color) |
| isGroup | _boolean_ | Whether to group bar charts[Column isGroup](/en/docs/api/plots/column#isgroup) | false |
| isStack | _boolean_ | Whether to stack histograms[Column isStack](/en/docs/api/plots/column#isstack) | false |
| columnWidthRatio | _number_ | Histogram width ratio [0-1] [Column columnWidthRatio](/en/docs/api/plots/column#columnwidthratio) | |
| marginRatio | _number_ | The spacing between columns in a grouping [0-1] applies only to grouping histograms[Column marginRatio](/en/docs/api/plots/column#marginratio) | |
| columnStyle | _StyleAttr \| Function_ | Column style configuration[Column columnStyle](/en/docs/api/plots/column#columnstyle) | |
| label | _ContinueLegendLabelCfg_ | Column label [Column label](/en/docs/api/plots/column#label) |
| color | _string \| string[] \| Function_ | Specifies the color of the point [Column color](/en/docs/api/plots/column#color) |
| groupField | _string_ | Split field, used to stack group histograms. Split field takes precedence over SeriesField. IsGroup: true will group by GroupField. | - |

### Plot Components
Expand Down
30 changes: 15 additions & 15 deletions docs/api/plots/dual-axes.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,27 +69,27 @@ const data = [[{ time: '1991'，value: 20 }], [{ time: '1992', count: 20 }]];
| 细分配置项名称 | 类型 | 功能描述 | 默认值 |
| -------------- | -------------------------------- | ------------------------------------------------------------------------------ | ------ |
| geometry | _string_ | 图形类型，指定为'line' | 'line' |
| seriesField | _string_ | 拆分字段, 若存在则为多折线，具体用法同[折线图 seriesfield](./line#seriesfield) |
| smooth | _boolean_ | 是否平滑，具体用法同[折线图 smooth](./line#smooth) | false |
| connectNulls | _boolean_ | 是否连接空数据，具体用法同[折线图 connectnulls](./line#connectnulls) | true |
| lineStyle | _StyleAttr \| Function_ | 折线图形样式，具体用法同[折线图 lineStyle](./line#linestyle) | |
| point | _pointStyle_ | 线数据点图形样式，具体用法同[折线图 point](./line#point) | |
| label | _ContinueLegendLabelCfg_ | 折线图 label,具体用法同[折线图 label](./line#label) |
| color | _string \| string[] \| Function_ | 指定点的颜色。具体用法同[折线图 color](./line#color) |
| seriesField | _string_ | 拆分字段, 若存在则为多折线，具体用法同[折线图 seriesfield](/zh/docs/api/plots/line#seriesfield) |
| smooth | _boolean_ | 是否平滑，具体用法同[折线图 smooth](/zh/docs/api/plots/line#smooth) | false |
| connectNulls | _boolean_ | 是否连接空数据，具体用法同[折线图 connectnulls](/zh/docs/api/plots/line#connectnulls) | true |
| lineStyle | _StyleAttr \| Function_ | 折线图形样式，具体用法同[折线图 lineStyle](/zh/docs/api/plots/line#linestyle) | |
| point | _pointStyle_ | 线数据点图形样式，具体用法同[折线图 point](/zh/docs/api/plots/line#point) | |
| label | _ContinueLegendLabelCfg_ | 折线图 label,具体用法同[折线图 label](/zh/docs/api/plots/line#label) |
| color | _string \| string[] \| Function_ | 指定点的颜色。具体用法同[折线图 color](/zh/docs/api/plots/line#color) |

柱形对应的图形配置为：

| 细分配置项名称 | 类型 | 功能描述 | 默认值 |
| ---------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------ |
| geometry | _string_ | 图形类型，应指定为'column' | |
| seriesField | _string_ | 拆分字段, 在分组柱状图下同 groupField、colorField，在堆积柱状图下同 stackField、colorField ，具体参考[柱形图 seriesfield](./column#seriesfield) |
| isGroup | _boolean_ | 是否分组柱形图，具体用法同[柱形图 isGroup](./column#isgroup) | false |
| isStack | _boolean_ | 是否堆积柱状图，具体用法同[柱形图 isStack](./column#isstack) | false |
| columnWidthRatio | _number_ | 柱状图宽度占比 [0-1] ，具体用法同[柱形图 columnWidthRatio](./column#columnwidthratio) | |
| marginRatio | _number_ | 分组中柱子之间的间距 [0-1]，仅对分组柱状图适用，具体用法同[柱形图 marginRatio](./column#marginratio) | |
| columnStyle | _StyleAttr \| Function_ | 柱子样式配置，具体用法同[柱形图 columnStyle](./column#columnstyle) | |
| label | _ContinueLegendLabelCfg_ | 柱形图 label,具体用法同[柱线图 label](./column#label) |
| color | _string \| string[] \| Function_ | 指定点的颜色。具体用法同[折线图 color](./column#color) |
| seriesField | _string_ | 拆分字段, 在分组柱状图下同 groupField、colorField，在堆积柱状图下同 stackField、colorField ，具体参考[柱形图 seriesfield](/zh/docs/api/plots/column#seriesfield) |
| isGroup | _boolean_ | 是否分组柱形图，具体用法同[柱形图 isGroup](/zh/docs/api/plots/column#isgroup) | false |
| isStack | _boolean_ | 是否堆积柱状图，具体用法同[柱形图 isStack](/zh/docs/api/plots/column#isstack) | false |
| columnWidthRatio | _number_ | 柱状图宽度占比 [0-1] ，具体用法同[柱形图 columnWidthRatio](/zh/docs/api/plots/column#columnwidthratio) | |
| marginRatio | _number_ | 分组中柱子之间的间距 [0-1]，仅对分组柱状图适用，具体用法同[柱形图 marginRatio](/zh/docs/api/plots/column#marginratio) | |
| columnStyle | _StyleAttr \| Function_ | 柱子样式配置，具体用法同[柱形图 columnStyle](/zh/docs/api/plots/column#columnstyle) | |
| label | _ContinueLegendLabelCfg_ | 柱形图 label,具体用法同[柱形图 label](/zh/docs/api/plots/column#label) |
| color | _string \| string[] \| Function_ | 指定点的颜色。具体用法同[柱形图 color](/zh/docs/api/plots/column#color) |
| groupField | _string_ | 拆分字段，用于堆叠+分组柱图，拆分优先级高于 seriesField，isGroup: true 时会根据 groupField 进行分组。 | - |

### 图表组件
Expand Down