docs(label): 补充 label position 配置的文档说明 (#2896)

antvis · Oct 8, 2021 · 379df35 · 379df35
1 parent 0e8de05
commit 379df35
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/common/label.en.md b/docs/common/label.en.md
@@ -13,7 +13,7 @@
 | labelLine  | _null_ \| _boolean_ \| _LabelLineCfg_                               | Used to set the style property of the text connector. NULL indicates that it is not displayed.                                                                   |
 | labelEmit  | _boolean_                                                    | Only applies to text in polar coordinates, indicating whether the text is radially displayed according to the Angle. True means on and false means off           |
 | layout     | _'overlap' \| 'fixedOverlap' \| 'limitInShape'_              | Text layout type, support a variety of layout function combination.                                                                                              |
-| position   | _'top' \| 'bottom' \| 'middle' \| 'left' \| 'right'_         | Specifies the position of the current Label relative to the current graphic                                                                                      |
+| position   | _'top' \| 'bottom' \| 'middle' \| 'left' \| 'right'_         | Specifies the position of the current Label relative to the current graphic  (Only works for column plot and bar plot, which geometry is interval)                                                                                   |
 | animate    | _boolean \| AnimateOption_                                   | Animation configuration.                                                                                                                                         |
 | formatter  | _Function_                                                   | Format function                                                                                                                                                  |
 | autoHide   | _boolean_                                                    | Whether to hide it automatically, default to false                                                                                                               |

diff --git a/docs/common/label.zh.md b/docs/common/label.zh.md
@@ -13,7 +13,7 @@
 | labelLine    | _null_ \| _boolean_ \| _LabelLineCfg_                                   | 用于设置文本连接线的样式属性，null 表示不展示。                                            |
 | labelEmit    | _boolean_                                                    | 只对极坐标下的文本生效，表示文本是否按照角度进行放射状显示，true 表示开启，false 表示关闭  |
 | layout       | _'overlap' \| 'fixedOverlap' \| 'limitInShape'_              | 文本布局类型，支持多种布局函数组合使用。                                                   |
-| position     | _'top' \| 'bottom' \| 'middle' \| 'left' \| 'right'_         | 指定当前 label 与当前图形的相对位置                                                        |
+| position     | _'top' \| 'bottom' \| 'middle' \| 'left' \| 'right'_         | 指定当前 label 与当前图形的相对位置 (只对 geometry 为 interval 的 柱条形图生效)                                                       |
 | animate      | _boolean \| AnimateOption_                                   | 动画配置。                                                                                 |
 | formatter    | _Function_                                                   | 格式化函数                                                                                 |
 | autoHide     | _boolean_                                                    | 是否自动隐藏，默认 false                                                                   |