在报价单、订单明细等场景中,粘贴单价、数量、折扣后需要自动计算每行合计,并同步更新表尾总合计。vxe-table 提供 editClosed、cellAreaPaste、cellAreaExtensionFill 等事件,可在编辑结束、区域粘贴、拖拽填充后统一触发计算,把联动逻辑集中在一处。
vxe-table 如何实现粘贴数据后自动计算合计?
监听 editClosed、cellAreaPaste、cellAreaExtensionFill 三个事件,在事件回调中对受影响的行调用行合计函数,再统一刷新表尾合计。配合 mouseConfig.area、keyboardConfig.isClip 开启区域选取与复制粘贴,即可覆盖手动编辑、粘贴、拖拽填充三种输入方式。
- 生效前提:
- mouseConfig.area 必须为 true,否则无法选取区域,cellAreaPaste 与 cellAreaExtensionFill 不会触发。
- keyboardConfig.isClip 必须为 true,否则复制粘贴整体不可用。
- editConfig 需配置编辑模式与触发方式,editClosed 才会在编辑结束时触发。
- showFooter 需为 true,表尾合计行才会显示;footerData 用于承载合计数据。
双击编辑单价、数量、折扣后失焦,该行合计自动更新;从 Excel 复制多行粘贴到表格,所有受影响行合计更新;拖拽填充柄扩展区域后,新填充行合计更新;三种操作后表尾总合计同步刷新。
代码
下面的配置实现“单价 × 数量 × 折扣 = 行合计”,并在编辑、粘贴、填充后自动刷新行合计与表尾总合计
<template>
<div>
<vxe-grid v-bind="gridOptions" v-on="gridEvents"></vxe-grid>
</div>
</template>
<script setup>
import { reactive } from 'vue'
import XEUtils from 'xe-utils'
const discountEditRender = reactive({
name: 'VxeSelect',
options: [
{ label: '无', value: 1 },
{ label: '95折', value: 0.95 },
{ label: '9折', value: 0.9 },
{ label: '85折', value: 0.85 },
{ label: '8折', value: 0.8 },
{ label: '75折', value: 0.75 },
{ label: '7折', value: 0.7 },
{ label: '65折', value: 0.65 },
{ label: '6折', value: 0.6 },
{ label: '55折', value: 0.55 },
{ label: '5折', value: 0.5 }
]
})
const countRow = reactive({
seq: '合计',
total: 0
})
const gridOptions = reactive({
height: 500,
border: true,
loading: false,
showOverflow: true,
showFooter: true,
columnConfig: {
resizable: true
},
mouseConfig: {
area: true
// 是否开启区域选取
},
areaConfig: {
multiple: false,
// 是否启用多区域选取功能
extendByCopy: true
// 是否启用扩展区域自动填充,当选取一个单元格时,自动将当前内容填充到扩展区域的所有单元格中(同时按住 ctrl 键可取消值自动识别数字功能)
},
editConfig: {
mode: 'cell',
// 单元格编辑模式
trigger: 'dblclick'
// 双击单元格激活编辑状态
},
keyboardConfig: {
isAll: true,
// 是否启用快捷键全选
isClip: true,
// 是否开启复制粘贴
isEdit: true,
// 是否开启任意键进入编辑(功能键除外)
isDel: true,
// 是否开启删除键功能
isEsc: true
// 是否开启Esc键关闭编辑功能
},
columns: [
{ field: 'seq', type: 'seq', width: 60 },
{ field: 'productName', title: '产品名称' },
{ field: 'price', title: '单价', editRender: { name: 'VxeNumberInput', props: { min: 0 } } },
{ field: 'quantity', title: '数量', editRender: { name: 'VxeNumberInput', props: { type: 'integer', min: 0, max: 999 } } },
{ field: 'discount', title: '折扣', editRender: discountEditRender },
{ field: 'total', title: '合计(自动打算)' }
],
data: [],
footerData: [countRow]
})
const calcFootTotal = () => {
let countNum = 0
gridOptions.data?.forEach((row) => {
countNum += XEUtils.toNumber(row.total)
})
countRow.total = countNum
}
const calcRowAmount = (row) => {
row.total = row.quantity ? XEUtils.round(row.price * row.quantity * (row.discount || 1), 2) : 0
}
const loadList = () => {
gridOptions.loading = true
setTimeout(() => {
const list = [
{ id: 10001, name: '张三', role: '前端开发', sex: '0', num: 23, age: 28, productName: '钢笔', price: 100, total: 0, quantity: 3, discount: 1, address: '北京市17号' },
{ id: 10002, name: '李四', role: '测试人员', sex: '1', num: 23, age: 22, productName: '触摸板', price: 150, total: 0, quantity: 11, discount: 1, address: '江苏省27号' },
{ id: 10003, name: '老六', role: '项目经理', sex: '0', num: 23, age: 32, productName: '无线键盘', price: 3e3, total: 0, quantity: 5, discount: 0.85, address: '深圳市19号' },
{ id: 10004, name: '小李', role: '后端开发', sex: '1', num: 456, age: 24, productName: '无线电脑', price: 5e4, total: 0, quantity: 24, discount: 0.8, address: '江苏省47号' },
{ id: 10005, name: '老万', role: '设计师', sex: '1', num: 23, age: 42, productName: 'Typec数据线', price: 600, total: 0, quantity: 100, discount: 1, address: '北京市18号' },
{ id: 10006, name: '小刘', role: '前端开发', sex: '0', num: 23, age: 38, productName: '电脑', price: 4e4, total: 0, quantity: 150, discount: 1, address: '上海市17号' },
{ id: 10007, name: '老徐', role: '测试人员', sex: '1', num: 100, age: 24, productName: '有线鼠标', price: 200, total: 0, quantity: 85, discount: 0.9, address: '北京市19号' },
{ id: 10008, name: '老二', role: '设计师', sex: '0', num: 345, age: 34, productName: '掌上手机', price: 1e5, total: 0, quantity: 64, discount: 0.95, address: '上海市11号' },
{ id: 10009, name: '小牛', role: '前端开发', sex: '1', num: 67, age: 52, productName: '无线鼠标', price: 500, total: 0, quantity: 55, discount: 0.8, address: '深圳市29号' },
{ id: 10010, name: '小帅', role: '测试人员', sex: '1', num: 23, age: 44, productName: '办公电脑', price: 3e3, total: 0, quantity: 863, discount: 1, address: '北京市37号' },
{ id: 10011, name: '老魏', role: '后端开发', sex: '0', num: 56, age: 52, productName: '触屏手机', price: 6e3, total: 0, quantity: 1e3, discount: 1, address: '深圳市12号' },
{ id: 10012, name: '小徐', role: '测试人员', sex: '1', num: 23, age: 16, productName: 'A4纸', price: 400, total: 0, quantity: 2200, discount: 0.75, address: '广州市16号' },
{ id: 10013, name: '小张', role: '设计师', sex: '1', num: 69, age: 16, productName: '机械键盘', price: 4e3, total: 0, quantity: 180, discount: 0.7, address: '广州市46号' },
{ id: 10014, name: '老冯', role: '前端开发', sex: '0', num: 36, age: 36, productName: 'USB数据线', price: 380, total: 0, quantity: 600, discount: 1, address: '广州市66号' },
{ id: 10015, name: '小哥', role: '后端开发', sex: '0', num: 33, age: 47, productName: '办公背包', price: 642, total: 0, quantity: 1600, discount: 1, address: '广州市56号' },
{ id: 10016, name: '李哥', role: '测试人员', sex: '1', num: 2, age: 42, productName: '充电宝', price: 250, total: 0, quantity: 200, discount: 1, address: '深圳市16号' }
]
list.forEach((row) => {
calcRowAmount(row)
})
gridOptions.data = list
gridOptions.loading = false
calcFootTotal()
}, 300)
}
const gridEvents = {
editClosed({ row }) {
calcRowAmount(row)
calcFootTotal()
},
cellAreaPaste({ targetAreas }) {
targetAreas.forEach((areaItem) => {
const { rows } = areaItem
rows.forEach((row) => {
calcRowAmount(row)
calcFootTotal()
})
})
},
cellAreaExtensionFill({ extendRows }) {
extendRows.forEach((row) => {
calcRowAmount(row)
calcFootTotal()
})
}
}
loadList()
</script>
- 期结果:
- 双击修改单价、数量或折扣,失焦后该行 total 立即更新,表尾合计同步变化。
- 从 Excel 复制多行单价或数量,选中区域后粘贴,所有受影响行的 total 重新计算,表尾合计更新。
- 拖拽填充柄扩展区域,新填充行按各自单价、数量、折扣计算合计,表尾合计更新。
说明
1. 计算函数与表尾合计
const calcRowAmount = (row) => {
row.total = row.quantity
? XEUtils.round(row.price * row.quantity * (row.discount || 1), 2)
: 0
}
const calcFootTotal = () => {
let countNum = 0
gridOptions.data?.forEach((row) => {
countNum += XEUtils.toNumber(row.total)
})
countRow.total = countNum
}
- calcRowAmount:单行合计,discount 为空时按 1 处理,结果保留两位小数。
- calcFootTotal:遍历全表累加 total,写入 footerData 中的合计行。
2. 三个事件的分工
| 事件 | 触发时机 | 回调参数 | 处理方式 |
|---|---|---|---|
| editClosed | 单元格编辑结束、失焦 | { row } | 重算当前行,刷新表尾 |
| cellAreaPaste | 区域粘贴完成 | { targetAreas } | 遍历受影响行重算,最后刷新表尾 |
| cellAreaExtensionFill | 拖拽填充扩展区域完成 | { extendRows } | 遍历填充行重算,最后刷新表尾 |
- cellAreaPaste 的 targetAreas 是数组,每项包含 rows,一次粘贴可能涉及多行。
- cellAreaExtensionFill 的 extendRows 为本次填充新增或修改的行集合。
关键配置参数
| 配置项 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| mouseConfig.area | Boolean | false | 区域选取总开关,粘贴与填充事件的前提 |
| areaConfig.multiple | Boolean | false | 是否允许多区域选取;示例为单区域 |
| areaConfig.extendByCopy | Boolean | false | 是否启用扩展区域自动填充 |
| keyboardConfig.isClip | Boolean | false | 复制粘贴总开关 |
| editConfig.mode | String | 'cell' | 编辑模式:cell / row |
| editConfig.trigger | String | 'click' | 鼠标触发编辑方式:click / dblclick |
| showFooter | Boolean | false | 是否显示表尾 |
| footerData | Array | — | 表尾数据,每项对应一行 |
| editClosed | Event | — | 编辑结束事件,参数含 row |
| cellAreaPaste | Event | — | 区域粘贴事件,参数含 targetAreas |
| cellAreaExtensionFill | Event | — | 扩展区域填充事件,参数含 extendRows |