From 5b4e60183a4e53d1596e3a70210533c0e4727cf4 Mon Sep 17 00:00:00 2001 From: S-Xiao <35770569+ShmilyXI@users.noreply.github.com> Date: Mon, 11 Nov 2019 15:41:54 +0800 Subject: [PATCH 1/2] Update tooltip.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit fix: showTooltip和getXY方法 --- bizCharts/zh/api/tooltip.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/bizCharts/zh/api/tooltip.md b/bizCharts/zh/api/tooltip.md index eca6944..eafa58c 100644 --- a/bizCharts/zh/api/tooltip.md +++ b/bizCharts/zh/api/tooltip.md @@ -44,6 +44,16 @@ * 'click': 鼠标点击出发; * 'none': 不触发 tooltip,用户通过 `chart.showTooltip()` 和 `chart.hideTooltip()` 来控制 tooltip 的显示和隐藏。 +当然在任何触发方式下,用户都可以通过调用 `chart.showTooltip(point)` 可以控制在固定的位置显示提示信息,参数 point 为画布上的坐标点,格式如下: +```js +const point = { + x: 23, + y: 30 +}; +``` +另外还提供了 chart.getXY({xField: value, yField: value}) 方法,用于获取数据对应在画布空间的坐标。 +![image](https://cdn.nlark.com/yuque/0/2018/png/100996/1539840191028-fded845c-8cdb-4112-8fbd-fe36bd588ab1.png?x-oss-process=image/resize,w_746) + #### `inPlot` * 类型: Boolean * 描述: 设置是否将 tooltip 限定在绘图区域内,默认为 true,即限定在绘图区域内。 @@ -192,38 +202,38 @@ itemTpl= '
  • ' * 描述: 用于控制是否允许鼠标进入 tooltip,默认为 false,即不允许进入。 ### canvasTooltip 属性 -通过设置配置项useHtml:false可以切换为canvasTooltip,以下配置项只有在useHtml为false的时候才能生效。 +通过设置配置项useHtml:false可以切换为canvasTooltip,以下配置项只有在useHtml为false的时候才能生效。样式详情见 [绘图属性](connector)。 #### `boardStyle` * 类型: Object -* 描述: 用于控制tooltip背景板的显示样式,更详细见 [绘图属性]() +* 描述: 用于控制tooltip背景板的显示样式。 #### `titleStyle` * 类型: Object -* 描述: 用于控制tooltip标题的显示样式,更详细见 [绘图属性]() +* 描述: 用于控制tooltip标题的显示样式。 #### `nameStyle` * 类型: Object -* 描述: 用于控制tooltip每一项 name 的显示样式,更详细见 [绘图属性]() +* 描述: 用于控制tooltip每一项 name 的显示样式。 #### `valueStyle` * 类型: Object -* 描述: 用于控制tooltip每一项 value 的显示样式,更详细见 [绘图属性]() +* 描述: 用于控制tooltip每一项 value 的显示样式。 #### `itemGap` * 类型: Number * 描述: 用于控制tooltip每一项之间的间距 ### miniTooltip 属性 -mini tooltip是一种极简的tooltip形式,只显示单个数据的数值。通过设置配置项type:mini切换为miniTooltip,以下配置项只有在type为'mini'的时候才能生效。 +mini tooltip是一种极简的tooltip形式,只显示单个数据的数值。通过设置配置项type:mini切换为miniTooltip,以下配置项只有在type为'mini'的时候才能生效。样式详情见 [绘图属性](connector)。 #### `boardStyle` * 类型: Object -* 描述: 用于控制tooltip背景板的显示样式,更详细见 [绘图属性]() +* 描述: 用于控制tooltip背景板的显示样式。 #### `valueStyle` * 类型: Object -* 描述: 用于控制tooltip每一项 value 的显示样式,更详细见 [绘图属性]() +* 描述: 用于控制tooltip每一项 value 的显示样式。 #### `triangleWidth` * 类型: Number From 60e45e79a8582f75fda922fe33e76a23af49cdd5 Mon Sep 17 00:00:00 2001 From: S-Xiao <35770569+ShmilyXI@users.noreply.github.com> Date: Tue, 12 Nov 2019 16:33:16 +0800 Subject: [PATCH 2/2] Update tooltip.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit fix: 为各个style配置项添加绘图属性的跳转连接 --- bizCharts/zh/api/tooltip.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/bizCharts/zh/api/tooltip.md b/bizCharts/zh/api/tooltip.md index eafa58c..b94831f 100644 --- a/bizCharts/zh/api/tooltip.md +++ b/bizCharts/zh/api/tooltip.md @@ -206,34 +206,34 @@ itemTpl= '
  • ' #### `boardStyle` * 类型: Object -* 描述: 用于控制tooltip背景板的显示样式。 +* 描述: 用于控制tooltip背景板的显示样式,样式详情见[绘图属性](./graphic) #### `titleStyle` * 类型: Object -* 描述: 用于控制tooltip标题的显示样式。 +* 描述: 用于控制tooltip标题的显示样式,样式详情见[绘图属性](./graphic) #### `nameStyle` * 类型: Object -* 描述: 用于控制tooltip每一项 name 的显示样式。 +* 描述: 用于控制tooltip每一项 name 的显示样式,样式详情见[绘图属性](./graphic) #### `valueStyle` * 类型: Object -* 描述: 用于控制tooltip每一项 value 的显示样式。 +* 描述: 用于控制tooltip每一项 value 的显示样式,样式详情见[绘图属性](./graphic) #### `itemGap` * 类型: Number * 描述: 用于控制tooltip每一项之间的间距 ### miniTooltip 属性 -mini tooltip是一种极简的tooltip形式,只显示单个数据的数值。通过设置配置项type:mini切换为miniTooltip,以下配置项只有在type为'mini'的时候才能生效。样式详情见 [绘图属性](connector)。 +mini tooltip是一种极简的tooltip形式,只显示单个数据的数值。通过设置配置项type:mini切换为miniTooltip,以下配置项只有在type为'mini'的时候才能生效。 #### `boardStyle` * 类型: Object -* 描述: 用于控制tooltip背景板的显示样式。 +* 描述: 用于控制tooltip背景板的显示样式,样式详情见[绘图属性](./graphic) #### `valueStyle` * 类型: Object -* 描述: 用于控制tooltip每一项 value 的显示样式。 +* 描述: 用于控制tooltip每一项 value 的显示样式,样式详情见[绘图属性](./graphic) #### `triangleWidth` * 类型: Number