elementHighlight

概述

elementHighlight 交互的对象是图表元素 element，当鼠标悬浮在元素上时，将该元素高亮显示。

触发：鼠标悬浮在元素上。
结束：鼠标移出元素。
影响状态：

悬浮的元素变为 active 状态。

其他元素变为 inactive 状态。

交互内置状态：

({
  // active 状态下的元素为1px黑色边框
  state: { active: { lineWidth: '1', stroke: '#000' } },
});

import { Column } from '@ant-design/plots';
import React from 'react';
import { createRoot } from 'react-dom';

const Demo = () => {

  const config ={
      data: {
        type: 'fetch',
        value:
          'https://gw.alipayobjects.com/os/bmw-prod/fb9db6b7-23a5-4c23-bbef-c54a55fee580.csv',
      },
      xField: 'letter',
      yField: 'frequency',
      state: { active: { fill: 'orange' }, inactive: { opacity: 0.5 } },
      axis: { y: { labelFormatter: '.0%' } },
      interaction: { elementHighlight: true }
  };

  return <Column {...config} />;
};

createRoot(document.getElementById('container')).render(<Demo />);

使用方式

配置 elementHighlight 交互有两种方式：

第一种，传入 boolean 设置是否开启交互。

({
  interaction: { elementHighlight: true }, // 采用默认配置
});

第二种，传入配置项对交互进行配置。

({
  interaction: {
    elementHighlight: {
      background: true,
    },
  },
});

配置层级

交互可以配置在 Mark 层级：

({
  interaction: { elementHighlight: true },
});

配置项

元素高亮交互配置有两处：

交互配置
元素高亮的样式

交互配置

属性	描述	类型	默认值
background	是否高亮背景	`boolean`	false
region	鼠标移动到元素空白区域时是否触发高亮(效果见下图)	`boolean`	false

元素高亮样式

元素高亮样式，效果见示例自定义高亮

属性	描述	类型	默认值
offset	主方向上的便偏移量	number	`0`
backgroundRadius	背景圆角	number \| (datum, index, data) => number	`0`
backgroundFill	背景填充色	string \| (datum, index, data) => string	`transparent`
backgroundFillOpacity	背景填充透明度	number \| (datum, index, data) => number	-
backgroundStroke	背景的描边	string \| (datum, index, data) => string	-
backgroundStrokeOpacity	背景描边透明度	number \| (datum, index, data) => number	-
backgroundLineWidth	背景描边的宽度	number \| (datum, index, data) => number	-
backgroundLineDash	背景描边的虚线配置，第一个值为虚线每个分段的长度，第二个值为分段间隔的距离。lineDash 设为[0,0]的效果为没有描边。	[number,number] \| (datum, index, data) => [number , number]	-
backgroundOpacity	背景的整体透明度	number \| (datum, index, data) => number	-
backgroundShadowColor	背景阴影颜色	string \| (datum, index, data) => string	-
backgroundShadowBlur	背景阴影的高斯模糊系数	number \| (datum, index, data) => number	-
backgroundShadowOffsetX	设置阴影距背景的水平距离	number \| (datum, index, data) => number	-
backgroundShadowOffsetY	设置阴影距背景的垂直距离	number \| (datum, index, data) => number	-
backgroundCursor	背景鼠标样式。同 css 的鼠标样式。	string \| (datum, index, data) => string	`default`

在 active 元素中配置背景的时候，不是以对象的形式来配置，而是以 background前缀加属性的方式来配置。

({
  state: {
    active: {
      backgroundRadius: 50,
      backgroundFill: '#000',
      backgroundFillOpacity: 0.9,
      backgroundStroke: '#DAF5EC',
      backgroundStrokeOpacity: 0.9,
      backgroundLineWidth: 2,
      backgroundLineDash: [4, 8],
      backgroundOpacity: 1,
      backgroundShadowColor: '#d3d3d3',
      backgroundShadowBlur: 10,
      backgroundShadowOffsetX: 10,
      backgroundShadowOffsetY: 10,
      backgroundCursor: 'pointer',
    },
  },
});

事件

监听事件

支持以下的事件：

element:highlight - 元素高亮时触发
element:unhighlight - 元素取消高亮时触发

chart.on('element:highlight', (e) => {
  console.log(e.data.data);
  console.log(e.data.group);
  console.log(e.nativeEvent);
});
chart.on('element:unhighlight', (e) => {
  console.log(e.nativeEvent);
});

触发交互

支持以下的事件：

element:highlight - 高亮数据
element:unhighlight - 取消高亮

chart.emit('element:highlight', {
  data: { data: { population: 5038433 } },
});
chart.emit('element:unhighlight', {});

示例

基础高亮

import { Column } from '@ant-design/plots';
import React from 'react';
import { createRoot } from 'react-dom';

const Demo = () => {

  const config ={
      autoFit: true,
      data: {
        type: 'fetch',
        value:
          'https://gw.alipayobjects.com/os/bmw-prod/fb9db6b7-23a5-4c23-bbef-c54a55fee580.csv',
      },
      xField: 'letter',
      yField: 'frequency',
      transform: [{ type: 'sortX', by: 'y', reverse: true, slice: 5 }],
      axis: { y: { labelFormatter: '.0%' } },
      interaction: { elementHighlight: { background: true, region: true } }
  };

  return <Column {...config} />;
};

createRoot(document.getElementById('container')).render(<Demo />);

自定义高亮

import { Column } from '@ant-design/plots';
import React from 'react';
import { createRoot } from 'react-dom';

const Demo = () => {

  const config ={
      autoFit: true,
      data: {
        type: 'fetch',
        value:
          'https://gw.alipayobjects.com/os/bmw-prod/fb9db6b7-23a5-4c23-bbef-c54a55fee580.csv',
      },
      xField: 'letter',
      yField: 'frequency',
      transform: [{ type: 'sortX', by: 'y', reverse: true, slice: 5 }],
      axis: { y: { labelFormatter: '.0%' } },
      state: {
        active: {
          offset: 10,
          backgroundRadius: 50,
          backgroundFill: (d) => (d.frequency > 0.1 ? 'red' : '#000'),
          backgroundFillOpacity: 0.9,
          backgroundStroke: '#DAF5EC',
          backgroundStrokeOpacity: 0.9,
          backgroundLineWidth: 2,
          backgroundLineDash: [4, 8],
          backgroundOpacity: 1,
          backgroundShadowColor: '#d3d3d3',
          backgroundShadowBlur: 10,
          backgroundShadowOffsetX: 10,
          backgroundShadowOffsetY: 10,
          backgroundCursor: 'pointer',
        },
      },
      interaction: {
        elementHighlight: {
          background: true,
        },
      }
  };

  return <Column {...config} />;
};

createRoot(document.getElementById('container')).render(<Demo />);