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

Jump to bottom

feat: update 'stackDim' documentation #243

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: update 'stackDim' documentation #243

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
6 changes: 5 additions & 1 deletion en/option/series/bar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,10 +132,14 @@ Configurations of select state. Available when [selectedMode](~series-bar.select

## stack(string) = null

Name of stack. On the same category axis, the series with the same `stack` name would be put on top of each other.
Name of stack. On the same category axis, the series with the same `stack` name would be put on top of each other. Recommend to use with `stackDim`.

Notice: `stack` only supports stacking on `value` and `log` axis for now. `time` and `category` axis are not supported.

## stackDim(string) = null
Dimension of stack. Usually chooses the axis that represents the value of data. Only used with `stack`.
Optional values: `'x'` and `'y'`.

## sampling(string)

The dowmsampling strategy used when the data size is much larger than pixel size. It will improve the performance when turned on. Defaults to be turned off, indicating that all the data points will be drawn.
Expand Down
6 changes: 5 additions & 1 deletion en/option/series/line.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Only work when main axis is `'category'` axis (`axis.type` is `'category'`). Opt

## stack(string) = null

If stack the value. On the same category axis, the series with the same `stack` name would be put on top of each other.
If stack the value. On the same category axis, the series with the same `stack` name would be put on top of each other. Recommend to use with `stackDim`.

Notice: `stack` only supports stacking on `value` and `log` axis for now. `time` and `category` axis are not supported.

Expand All @@ -68,6 +68,10 @@ The effect of the below example could be seen through stack switching of [toolbo

{{ use: partial-cursor() }}

## stackDim(string) = null
Dimension of stack. Usually chooses the axis that represents the value of data. Only used with `stack`.
Optional values: `'x'` and `'y'`.

## connectNulls(boolean) = false

<ExampleUIControlBoolean />
Expand Down
6 changes: 5 additions & 1 deletion zh/option/series/bar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,10 +210,14 @@ option = {

## stack(string) = null

数据堆叠，同个类目轴上系列配置相同的`stack`值可以堆叠放置。
数据堆叠，同个类目轴上系列配置相同的`stack`值可以堆叠放置。推荐与`stackDim`一起使用。

注：目前`stack`只支持堆叠于 `value` 和 `log` 类型的类目轴上，不支持 `time` 和 `category` 类型的类目轴。

## stackDim(string) = null
数据堆叠的方向，一般选择表示数据值的轴。只用于与`stack`一起使用。
可选值：`'x'`和`'y'`

## sampling(string)

柱状图在数据量远大于像素点时候的降采样策略，开启后可以有效的优化图表的绘制效率，默认关闭，也就是全部绘制不过滤数据点。
Expand Down
6 changes: 5 additions & 1 deletion zh/option/series/line.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ const option = {

## stack(string) = null

数据堆叠，同个类目轴上系列配置相同的`stack`值后，后一个系列的值会在前一个系列的值上相加。
数据堆叠，同个类目轴上系列配置相同的`stack`值后，后一个系列的值会在前一个系列的值上相加。推荐与`stackDim`一起使用。

注：目前`stack`只支持堆叠于 `value` 和 `log` 类型的类目轴上，不支持 `time` 和 `category` 类型的类目轴。

Expand All @@ -97,6 +97,10 @@ const option = {

{{ use: partial-cursor() }}

## stackDim(string) = null
数据堆叠的方向，一般选择表示数据值的轴。只用于与`stack`一起使用。
可选值：`'x'`和`'y'`

## connectNulls(boolean) = false

<ExampleUIControlBoolean />
Expand Down