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

Question

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

我当前的图表是这样的：

我想要的输出必须显示另一个属性，即百分比，如下所示：

我已经阅读了文档，但我无法处理这个问题，因为它非常笼统，而且我是 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'
        ]
      }]
    };

Answer 1

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

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

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

在下面的示例中，我设置 "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/

Answer 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
    }
  }
}

Answer 3

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

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

Answer 4

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

我是 javascript 的新手，所以从 Chart.js 3.4.1 文档中我并不清楚如何使用工具提示 object。按照建议，通过使用 console.log(tooltipItems)，我能够获得我需要的信息。

我最终得到了一个配置 object，在 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
            },
          },
        },
      },
    },

Answer 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"
      }
    },
  },
},

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

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

javascript

customization

tooltip

chart.js2