如何自定义图表.js 2.0 圆环图的工具提示?

How to customize the tooltip of a Chart.js 2.0 Doughnut Chart?

提问人:RamAlx 提问时间:4/25/2017 最后编辑:Tot ZamRamAlx 更新时间:10/4/2023 访问量:154967

问:

我正在尝试使用 Chart.js2 中的圆环图显示一些数据。

我当前的图表如下所示:
current chart

我想要的输出必须显示另一个属性,即百分比,如下所示:
desired chart with percentage

我已经阅读了文档,但我无法应付这个问题,因为它非常通用,而且我是 JavaScript 的新手。

我的第一个图表的代码如下:

const renderCashCurrencyPie = (cashAnalysisBalances) => {
  if (cashAnalysisBalances) {
    const currenciesName = cashAnalysisBalances
    .map(curName => curName.currency);

    const availableCash = cashAnalysisBalances
    .map(avCash => avCash.availableCash);

    let currenciesCounter = 0;
    for (let i = 0; i < currenciesName.length; i += 1) {
      if (currenciesName[i] !== currenciesName[i + 1]) {
        currenciesCounter += 1;
      }
    }

    const currenciesData = {
      labels: currenciesName,
      datasets: [{
        data: availableCash,
        backgroundColor: [
          '#129CFF',
          '#0C6DB3',
          '#FF6384',
          '#00FFFF'
        ],
        hoverBackgroundColor: [
          '#FF6384',
          '#36A2EB',
          '#FFCE56',
          '#00FFFF'
        ]
      }]
    };
JavaScript 工具提示 自定义 chart.js2

评论


答:

160赞 Tot Zam 5/17/2017 #1

您可以使用图表选项工具提示配置部分自定义工具提示,如下所述:http://www.chartjs.org/docs/latest/configuration/tooltip.html#tooltip-configuration

如下面的示例代码所示,您可以更改颜色、大小和样式等内容。查看上面链接的文档,了解可配置选项的完整列表。

如果要将百分比添加到工具提示显示中,可以使用工具提示回调。该文档列出了所有可能的可自定义回调字段。

在下面的示例中,我将“title”设置为显示标签名称,“label”用于显示值,并将百分比添加到“afterLabel”中。

var myChart = new Chart(ctx, {
  type: 'doughnut',
  data: data,
  options: {
    tooltips: {
      callbacks: {
        title: function(tooltipItem, data) {
          return data['labels'][tooltipItem[0]['index']];
        },
        label: function(tooltipItem, data) {
          return data['datasets'][0]['data'][tooltipItem['index']];
        },
        afterLabel: function(tooltipItem, data) {
          var dataset = data['datasets'][0];
          var percent = Math.round((dataset['data'][tooltipItem['index']] / dataset["_meta"][0]['total']) * 100)
          return '(' + percent + '%)';
        }
      },
      backgroundColor: '#FFF',
      titleFontSize: 16,
      titleFontColor: '#0066ff',
      bodyFontColor: '#000',
      bodyFontSize: 14,
      displayColors: false
    }
  }
});

工作 JSFiddle:https://jsfiddle.net/m7s43hrs/

评论

1赞 dNurb 2/12/2019
data['datasets'][tooltipItem.datasetIndex]['data'][tooltipItem.index]因为我们也有 dataSet 索引。
0赞 Luca Davanzo 10/24/2019
是的,如果您需要精简定制,这很好。但是,如果您需要渲染一个按钮,或者一个表格,或者其他什么呢?你必须实现选项,但不太容易(github.com/jerairrest/react-chartjs-2/issues/450custom)
0赞 Sondre 11/9/2020
如果希望将数据集标签作为标题:data['datasets'][tooltipItem[0].datasetIndex].label
1赞 Olcay 6/16/2021
当我尝试在到达 meta 后获得总值时,我注意到 meta nuber 是动态变化的(例如:0 ,1,14,20)。这就是为什么我将dataset["_meta"][0]['total']let total = dataset["_meta"][Object.keys(dataset["_meta"])[0]]['total']
1赞 Izzi 9/9/2021
而对于 v3.5?这完全改变了。
11赞 Merenzo 2/28/2018 #2

根据 @Tot Zam 的回答,但为了简洁起见,使用箭头函数:

options: {
  tooltips: {
    callbacks: {
      title: (items, data) => data.datasets[items[0].datasetIndex].data[items[0].index].myProperty1,
      label: (item, data) => data.datasets[item.datasetIndex].data[item.index].myProperty2
    }
  }
}
2赞 Tuhin 5/21/2021 #3

任何在 2021 年寻找解决方案以将标签设置为工具提示标题的人,下面的代码片段都可以。使用 console.dir(tooltipItems) 查看 tooltipItems 的内容。

callbacks: {
        title: function (tooltipItems) {
          return tooltipItems[0].formattedValue;
        }
      }

评论

0赞 AbbathCL 6/19/2021
这怎么可能行得通?我仍然无法定义分散。
0赞 Tuhin 6/20/2021
@JorgeAlvarado适用于折线图。确保已将上述代码块放在“选项”>“工具提示”下作为属性。
0赞 AbbathCL 6/22/2021
我通过一些命令使这成为可能;我正在使用 Scatter
0赞 Izzi 9/8/2021
哼。这奏效了!——除了我刚回来tooltipItems.formattedValue
3赞 Sideshowlol 7/7/2021 #4

感谢 Tuhin 的回答。它帮助我弄清楚如何使用回调函数更改工具提示标题。

我对 javascript 很陌生,所以从 Chart.js 3.4.1 文档中我并不明显地了解如何使用 tooltip 对象。通过使用控制台.log(tooltipItems),正如建议的那样,我能够获得所需的信息。

我最终得到了一个配置对象,在 options.plugins 中设置了以下回调。我希望将缩短的日期字符串显示为工具提示的标题。使用 toDateString() 可以解决问题。

以下是我设置回调的方法:

    options: {
      ...

      plugins: {
        tooltip: {
          callbacks: {
            title: tooltipItems => {
              title = tooltipItems[0].parsed.x
              if (title !== null) {
                console.dir(title)
                title = new Date(title).toDateString()
              }
              return title
            },
          },
        },
      },
    },

评论

1赞 Noel Baron 8/25/2021
这适用于 react-chartjs-2。options.plugins.tooltip.callbacks 是您需要的路径。
5赞 Jayanth Kumar T 10/22/2021 #5

对于使用最新 Chart.js v3.5.1 版本的用户,您可以添加以下代码来自定义工具提示。

将下面的插件对象添加到图表选项

plugins: {
  tooltip: {
    enabled: true,
    usePointStyle: true,
    callbacks: { 
      // To change title in tooltip
      title: (data) => { return data[0].parsed.x } 

      // To change label in tooltip
      label: (data) => { 
            return data.parsed.y === 2 ? "Good" : "Critical"
      }
    },
  },
},
2赞 Dev Hormiga 6/16/2022 #6

嗨,我找到了一个实用的解决方案来格式化工具提示的文本

 const label = (context) => {
   
    let lbl = context.label+' '+ context.formattedValue+' ' + '%'
    return lbl
  }
  const chartOptions = { 
    plugins:{
      tooltip: {
        callbacks: {
            label: label,
        }, 
<script src="https://cdnjs.cloudflare.com/ajax/libs/react/16.6.3/umd/react.production.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/react-dom/16.6.3/umd/react-dom.production.min.js"></script>

0赞 Amine Soumiaa 10/4/2023 #7

下面是一个带有工具提示的圆环图示例(Chart.js 4.4.0):

let chart = new Chart(el.getContext('2d'), {
    type: 'doughnut',
    data: {
      datasets: [
        {
          data: this.doughnutData
        }
      ]
    },
    options: {
      plugins: {
        tooltip: {
          callbacks: {
            label: function(context) {
              var label = context.dataset.data[context.dataIndex]['label'];
              var value = context.formattedValue;
              return label + ' : ' + value + ' %';
            }
          }
        }
      },
      responsive: true,
      // This doughnut chart will respond to mousemove or click (show label-percentage).
      events: ['click','mousemove']
    }
  });

它工作正常,希望它能帮助:)

工具提示文档:https://www.chartjs.org/docs/latest/configuration/tooltip.html#tooltip-item-context