事件 event
介绍
表格事件列表,可以根据实际需要,监听所需事件,实现自定义业务。
事件具体的回传数据可进行实际测试来观察是否满足业务需求,或者跟我们沟通对接。
比较全面的事件列表请参考:https://visactor.io/vtable/api/events
| 名称 | 事件名 | 描述 |
|---|---|---|
| 生命周期事件:完成初始化 | INITIALIZED | 生命周期事件:成功初始化完成后触发 |
| 渲染完成 | AFTER_RENDER | 每次渲染完成触发 |
| 监听图表事件 | 同 vchart 教程中规定的事件 | 表格中嵌入图表,需要监听图表事件的情况使用。使用方法onVChartEvent非on |
| 点击 | CLICK_CELL | 单元格点击事件 |
| 双击 | DBLCLICK_CELL | 单元格双击事件 |
| 右键 | CONTEXTMENU_CELL | 单元格右键事件 |
| 右键画布 | CONTEXTMENU_CANVAS | 画布右键事件 |
| 键盘按下 | CLICK_CELL | 键盘按下事件 |
| 鼠标按下 | MOUSEDOWN_CELL | 单元格鼠标按下事件 |
| 鼠标松开 | MOUSEUP_CELL | 单元格鼠标松开事件 |
| 选中状态改变 | SELECTED_CELL | 单元格选中状态改变事件 |
| 选中状态被清除 | SELECTED_CLEAR | 单元格选中状态全部清除事件 |
| 鼠标进入 | MOUSEENTER_CELL | 鼠标进入单元格事件 |
| 鼠标移动 | MOUSEMOVE_CELL | 鼠标在某个单元格上移动事件 |
| 鼠标离开 | MOUSELEAVE_CELL | 鼠标离开单元格事件 |
| 拖拽列宽 | RESIZE_COLUMN | 列宽调整事件 |
| 拖拽列宽结束 | RESIZE_COLUMN_END | 列宽调整结束事件 |
| 拖拽行高 | RESIZE_ROW | 行高调整事件 |
| 拖拽行高结束 | RESIZE_ROW_END | 行高调整结束事件 |
| 合并单元格 | MERGE_CELLS | mergeCells 调用成功后触发 |
| 取消合并单元格 | UNMERGE_CELLS | unmergeCells 调用后触发 |
| 拖拽表头 | CHANGE_HEADER_POSITION | 拖拽表头移动位置的事件 |
| 点击排序 | SORT_CLICK | 点击排序图标事件 |
| 执行完排序 | AFTER_SORT | 执行完排序事件 |
| 点击固定列 | FREEZE_CLICK | 点击固定列图标事件 |
| 滚动 | SCROLL | 滚动表格事件 |
| 滚动 | SCROLL_HORIZONTAL_END | 横向滚动右侧事件 |
| 滚动 | SCROLL_VERTICAL_END | 竖向滚动底部事件 |
| 点击下拉图标 | DROPDOWN_MENU_CLICK | 点击下拉菜单图标事件 |
| 点击下拉菜单 | MENU_CLICK | 点击下拉菜单事件 |
| 鼠标经过迷你图 | MOUSEOVER_CHART_SYMBOL | 鼠标经过迷你图标记事件 |
| 拖拽框选鼠标松开 | DRAG_SELECT_END | 拖拽框选单元格鼠标松开事件 |
| 下钻按钮点击 | DRILLMENU_CLICK | 下钻按钮点击事件 |
| 透视表树形展示收起 | TREE_HIERARCHY_STATE_CHANGE | 透视表树形结构展示收起状态改变事件 |
| 按键 | KEYDOWN | 键盘按下事件 |
| 图例项点击事件 | LEGEND_ITEM_CLICK | 鼠标点击图例中某一项 |
| 图例项 hover | LEGEND_ITEM_HOVER | 鼠标 hover 图例中某一项 |
| 图例项 unhover | LEGEND_ITEM_UNHOVER | 鼠标离开 hover 的图例项 |
| 鼠标进入坐标轴 | MOUSEENTER_AXIS | 鼠标进入坐标轴组件 |
| 鼠标离开坐标轴 | MOUSELEAVE_AXIS | 鼠标离开坐标轴组件 |
| 监听复制 | COPY_DATA | 当使用快捷键复制单元格后触发该事件 |
| 鼠标进入表格区域 | MOUSEENTER_TABLE | 鼠标进入表格区域触发该事件 |
| 鼠标离开表格区域 | MOUSELEAVE_TABLE | 鼠标离开表格区域触发该事件 |
| 鼠标按下 | MOUSEDOWN_TABLE | 鼠标在表格区域按下触发该事件 |
| 粘贴事件的数据 | PASTED_DATA | 粘贴数据事件 |
| 插件事件 | PLUGIN_EVENT | 插件想触发事件到表格,其他插件可以监听该类型事件 |
事件监听方式
const {
CLICK_CELL,
DBLCLICK_CELL,
DBLTAP_CELL,
MOUSEDOWN_CELL,
MOUSEUP_CELL,
SELECTED_CELL,
KEYDOWN,
MOUSEMOVE_CELL,
MOUSEENTER_CELL,
MOUSELEAVE_CELL,
MOUSEOUT_CELL,
INPUT_CELL,
PASTE_CELL,
RESIZE_COLUMN,
RESIZE_ROW,
SCROLL,
SCROLL_HORIZONTAL_END,
SCROLL_VERTICAL_END,
CHANGED_VALUE,
FREEZE_CLICK,
SORT_CLICK,
AFTER_SORT,
DROPDOWN_MENU_CLICK,
CONTEXTMENU_CELL,
CONTEXTMENU_CANVAS
} = VTable.ListTable.EVENT_TYPE;
const tableInstance =new ListTable(options);
tableInstance.on(CLICK_CELL, (...args) => console.log(CLICK_CELL, args));