vxe-table 3.4.6 → 3.4.7

package/packages/table/src/methods.js

@@ -3,7 +3,7 @@ import GlobalConfig from '../../v-x-e-table/src/conf'
 import Cell from './cell'
 import VXETable from '../../v-x-e-table'
 import { UtilTools, DomTools } from '../../tools'
-import { clearTableAllStatus, handleFieldOrColumn, restoreScrollLocation, restoreScrollListener } from './util'
+import { clearTableAllStatus, handleFieldOrColumn, restoreScrollLocation, restoreScrollListener, toTreePathSeq } from './util'
 import { eqEmptyValue, isEnableConf } from '../../tools/src/utils'
 import { browse, getPaddingTopBottomSize, setScrollTop, setScrollLeft } from '../../tools/src/dom'
 import { formats } from '../../v-x-e-table/src/formats'
@@ -283,7 +283,7 @@ const Methods = {
     return clearTableAllStatus(this)
   },
   /**
-   * 同步 data 数据
+   * 同步 data 数据（即将废弃）
    * 如果用了该方法，那么组件将不再记录增删改的状态，只能自行实现对应逻辑
    * 对于某些特殊的场景，比如深层树节点元素发生变动时可能会用到
    */
@@ -301,9 +301,33 @@ const Methods = {
     return this.handleTableData(true).then(this.updateFooter).then(this.recalculate)
   },
   handleTableData (force) {
-    const { scrollYLoad, scrollYStore } = this
-    const fullData = force ? this.updateAfterFullData() : this.afterFullData
-    this.tableData = scrollYLoad ? fullData.slice(scrollYStore.startIndex, scrollYStore.endIndex) : fullData.slice(0)
+    const { treeConfig, scrollYLoad, scrollYStore, fullDataRowIdData, treeExpandeds, treeOpts } = this
+    let fullList = []
+    // 是否进行数据处理
+    if (force) {
+      this.updateAfterFullData()
+    }
+    // 如果为虚拟树，将树结构拍平
+    if (treeConfig && treeOpts.transform) {
+      const expandMaps = new Map()
+      XEUtils.eachTree(this.afterTreeFullData, (row, index, items, path, parent) => {
+        if (!parent || (expandMaps.has(parent) && treeExpandeds.indexOf(parent) > -1)) {
+          expandMaps.set(row, 1)
+          fullList.push(row)
+        }
+      }, { children: treeOpts.mapChildren })
+    } else {
+      fullList = this.afterFullData
+    }
+    const tableData = scrollYLoad ? fullList.slice(scrollYStore.startIndex, scrollYStore.endIndex) : fullList.slice(0)
+    tableData.forEach((row, $index) => {
+      const rowid = getRowid(this, row)
+      const rest = fullDataRowIdData[rowid]
+      if (rest) {
+        rest.$index = $index
+      }
+    })
+    this.tableData = tableData
     return this.$nextTick()
   },
   updateScrollYStatus (fullData) {
@@ -334,13 +358,24 @@ const Methods = {
           if (!treeOpts.children) {
             UtilTools.error('vxe.error.reqProp', ['tree-config.children'])
           }
+          if (!treeOpts.mapChildren) {
+            UtilTools.error('vxe.error.reqProp', ['tree-config.mapChildren'])
+          }
+          if (treeOpts.children === treeOpts.mapChildren) {
+            UtilTools.error('vxe.error.errConflicts', ['tree-config.children', 'tree-config.mapChildren'])
+          }
           fullData.forEach(row => {
             if (row[treeOpts.children] && row[treeOpts.children].length) {
               UtilTools.warn('vxe.error.errConflicts', ['tree-config.transform', `row.${treeOpts.children}`])
             }
           })
         }
-        treeData = XEUtils.toArrayTree(fullData, { key: treeOpts.rowField, parentKey: treeOpts.parentField, children: treeOpts.children })
+        treeData = XEUtils.toArrayTree(fullData, {
+          key: treeOpts.rowField,
+          parentKey: treeOpts.parentField,
+          children: treeOpts.children,
+          mapChildren: treeOpts.mapChildren
+        })
         fullData = treeData.slice(0)
       } else {
         treeData = fullData.slice(0)
@@ -356,7 +391,7 @@ const Methods = {
     this.scrollYLoad = sYLoad
     // 全量数据
     this.tableFullData = fullData
-    this.treeFullData = treeData
+    this.tableFullTreeData = treeData
     // 缓存数据
     this.cacheRowMap(true)
     // 原始数据
@@ -530,12 +565,14 @@ const Methods = {
    * 牺牲数据组装的耗时，用来换取使用过程中的流畅
    */
   cacheRowMap (source) {
-    const { treeConfig, treeOpts, tableFullData, fullDataRowMap, fullAllDataRowMap } = this
+    const { treeConfig, treeOpts, tableFullData, fullDataRowMap, fullAllDataRowMap, tableFullTreeData } = this
     let { fullDataRowIdData, fullAllDataRowIdData } = this
     const rowkey = getRowkey(this)
     const isLazy = treeConfig && treeOpts.lazy
     const handleCache = (row, index, items, path, parent, nodes) => {
       let rowid = getRowid(this, row)
+      const seq = treeConfig && path ? toTreePathSeq(path) : index + 1
+      const level = nodes ? nodes.length - 1 : 0
       if (eqEmptyValue(rowid)) {
         rowid = getRowUniqueId()
         XEUtils.set(row, rowkey, rowid)
@@ -543,7 +580,7 @@ const Methods = {
       if (isLazy && row[treeOpts.hasChild] && XEUtils.isUndefined(row[treeOpts.children])) {
         row[treeOpts.children] = null
       }
-      const rest = { row, rowid, index: treeConfig && parent ? -1 : index, items, parent, level: nodes ? nodes.length - 1 : 0 }
+      const rest = { row, rowid, seq, index: treeConfig && parent ? -1 : index, _index: -1, $index: -1, items, parent, level }
       if (source) {
         fullDataRowIdData[rowid] = rest
         fullDataRowMap.set(row, rest)
@@ -558,14 +595,14 @@ const Methods = {
     fullAllDataRowIdData = this.fullAllDataRowIdData = {}
     fullAllDataRowMap.clear()
     if (treeConfig) {
-      XEUtils.eachTree(tableFullData, handleCache, treeOpts)
+      XEUtils.eachTree(tableFullTreeData, handleCache, treeOpts)
     } else {
       tableFullData.forEach(handleCache)
     }
   },
   loadTreeChildren (row, childRecords) {
     const { keepSource, tableSourceData, treeOpts, fullDataRowIdData, fullDataRowMap, fullAllDataRowMap, fullAllDataRowIdData } = this
-    const { children } = treeOpts
+    const { transform, children, mapChildren } = treeOpts
     const rest = fullAllDataRowIdData[getRowid(this, row)]
     const parentLevel = rest ? rest.level : 0
     return this.createData(childRecords).then((rows) => {
@@ -578,13 +615,16 @@ const Methods = {
       }
       XEUtils.eachTree(rows, (childRow, index, items, path, parent, nodes) => {
         const rowid = getRowid(this, childRow)
-        const rest = { row: childRow, rowid, index: -1, items, parent, level: parentLevel + nodes.length }
+        const rest = { row: childRow, rowid, seq: -1, index: -1, _index: -1, $index: -1, items, parent, level: parentLevel + nodes.length }
         fullDataRowIdData[rowid] = rest
         fullDataRowMap.set(childRow, rest)
         fullAllDataRowIdData[rowid] = rest
         fullAllDataRowMap.set(childRow, rest)
       }, treeOpts)
       row[children] = rows
+      if (transform) {
+        row[mapChildren] = rows
+      }
       return rows
     })
   },
@@ -724,6 +764,21 @@ const Methods = {
     }
     return null
   },
+  /**
+   * 根据 row 获取序号
+   * @param {Row} row 行对象
+   */
+  getRowSeq (row) {
+    const { fullDataRowIdData } = this
+    if (row) {
+      const rowid = getRowid(this, row)
+      const rest = fullDataRowIdData[rowid]
+      if (rest) {
+        return rest.seq
+      }
+    }
+    return -1
+  },
   /**
    * 根据 row 获取相对于 data 中的索引
    * @param {Row} row 行对象
@@ -1061,10 +1116,12 @@ const Methods = {
    * 如果存在筛选条件，继续处理
    */
   updateAfterFullData () {
-    const { tableFullColumn, tableFullData, filterOpts, sortOpts } = this
+    const { tableFullColumn, tableFullData, filterOpts, sortOpts, treeConfig, treeOpts, tableFullTreeData } = this
     const { remote: allRemoteFilter, filterMethod: allFilterMethod } = filterOpts
     const { remote: allRemoteSort, sortMethod: allSortMethod, multiple: sortMultiple } = sortOpts
-    let tableData = tableFullData.slice(0)
+    const { transform } = treeOpts
+    let tableData = []
+    let tableTree = []
     const filterColumns = []
     const orderColumns = []
     tableFullColumn.forEach(column => {
@@ -1087,7 +1144,7 @@ const Methods = {
       }
     })
     if (filterColumns.length) {
-      tableData = tableData.filter(row => {
+      const handleFilter = (row) => {
         return filterColumns.every(({ column, valueList, itemList }) => {
           if (valueList.length && !allRemoteFilter) {
             const { filterMethod, filterRender } = column
@@ -1108,29 +1165,103 @@ const Methods = {
           }
           return true
         })
-      })
+      }
+      if (treeConfig && transform) {
+        // 筛选虚拟树
+        tableTree = XEUtils.searchTree(tableFullTreeData, handleFilter, { ...treeOpts, original: true })
+        tableData = tableTree
+      } else {
+        tableData = treeConfig ? tableFullTreeData.filter(handleFilter) : tableFullData.filter(handleFilter)
+        tableTree = tableData
+      }
+    } else {
+      if (treeConfig && transform) {
+        // 还原虚拟树
+        tableTree = XEUtils.searchTree(tableFullTreeData, () => true, { ...treeOpts, original: true })
+        tableData = tableTree
+      } else {
+        tableData = treeConfig ? tableFullTreeData.slice(0) : tableFullData.slice(0)
+        tableTree = tableData
+      }
     }
     const firstOrderColumn = orderColumns[0]
     if (!allRemoteSort && firstOrderColumn) {
-      if (allSortMethod) {
-        const sortRests = allSortMethod({ data: tableData, column: firstOrderColumn.column, property: firstOrderColumn.property, order: firstOrderColumn.order, sortList: orderColumns, $table: this })
-        tableData = XEUtils.isArray(sortRests) ? sortRests : tableData
+      if (treeConfig && transform) {
+        // 虚拟树和列表一样，只能排序根级节点
+        if (allSortMethod) {
+          const sortRests = allSortMethod({ data: tableTree, sortList: orderColumns, $table: this })
+          tableTree = XEUtils.isArray(sortRests) ? sortRests : tableTree
+        } else {
+          tableTree = XEUtils.orderBy(tableTree, orderColumns.map(({ column, order }) => [getOrderField(this, column), order]))
+        }
+        tableData = tableTree
       } else {
-        // 兼容 v4
-        if (sortMultiple) {
-          tableData = XEUtils.orderBy(tableData, orderColumns.map(({ column, order }) => [getOrderField(this, column), order]))
+        if (allSortMethod) {
+          const sortRests = allSortMethod({ data: tableData, column: firstOrderColumn.column, property: firstOrderColumn.property, order: firstOrderColumn.order, sortList: orderColumns, $table: this })
+          tableData = XEUtils.isArray(sortRests) ? sortRests : tableData
         } else {
-          // 兼容 v2，在 v4 中废弃， sortBy 不能为数组
-          let sortByConfs
-          if (XEUtils.isArray(firstOrderColumn.sortBy)) {
-            sortByConfs = firstOrderColumn.sortBy.map(item => [item, firstOrderColumn.order])
+          // 兼容 v4
+          if (sortMultiple) {
+            tableData = XEUtils.orderBy(tableData, orderColumns.map(({ column, order }) => [getOrderField(this, column), order]))
+          } else {
+            // 兼容 v2，在 v4 中废弃， sortBy 不能为数组
+            let sortByConfs
+            if (XEUtils.isArray(firstOrderColumn.sortBy)) {
+              sortByConfs = firstOrderColumn.sortBy.map(item => [item, firstOrderColumn.order])
+            }
+            tableData = XEUtils.orderBy(tableData, sortByConfs || [firstOrderColumn].map(({ column, order }) => [getOrderField(this, column), order]))
           }
-          tableData = XEUtils.orderBy(tableData, sortByConfs || [firstOrderColumn].map(({ column, order }) => [getOrderField(this, column), order]))
         }
+        tableTree = tableData
       }
     }
     this.afterFullData = tableData
-    return tableData
+    this.afterTreeFullData = tableTree
+    this.updateAfterDataIndex()
+  },
+  /**
+   * 预编译
+   * 对渲染中的数据提前解析序号及索引。牺牲提前编译耗时换取渲染中额外损耗，使运行时更加流畅
+   */
+  updateAfterDataIndex () {
+    const { treeConfig, afterFullData, fullDataRowIdData, fullAllDataRowIdData, afterTreeFullData, treeOpts } = this
+    if (treeConfig) {
+      XEUtils.eachTree(afterTreeFullData, (row, index, items, path) => {
+        const rowid = getRowid(this, row)
+        const allrest = fullAllDataRowIdData[rowid]
+        const fullrest = fullDataRowIdData[rowid]
+        const seq = path.map((num, i) => i % 2 === 0 ? (Number(num) + 1) : '.').join('')
+        if (allrest) {
+          allrest.seq = seq
+          allrest._index = index
+        }
+        if (fullrest) {
+          fullrest.seq = seq
+          fullrest._index = index
+        } else {
+          fullAllDataRowIdData[rowid] = { row, rowid, seq, index: -1, $index: -1, _index: index, items: [], parent: null, level: 0 }
+          fullDataRowIdData[rowid] = { row, rowid, seq, index: -1, $index: -1, _index: index, items: [], parent: null, level: 0 }
+        }
+      }, { children: treeOpts.mapChildren })
+    } else {
+      afterFullData.forEach((row, index) => {
+        const rowid = getRowid(this, row)
+        const allrest = fullAllDataRowIdData[rowid]
+        const fullrest = fullDataRowIdData[rowid]
+        const seq = index + 1
+        if (allrest) {
+          allrest.seq = seq
+          allrest._index = index
+        }
+        if (fullrest) {
+          fullrest.seq = seq
+          fullrest._index = index
+        } else {
+          fullAllDataRowIdData[rowid] = { row, rowid, seq, index: -1, $index: -1, _index: index, items: [], parent: null, level: 0 }
+          fullDataRowIdData[rowid] = { row, rowid, seq, index: -1, $index: -1, _index: index, items: [], parent: null, level: 0 }
+        }
+      })
+    }
   },
   /**
    * 根据行的唯一主键获取行
@@ -3696,7 +3827,7 @@ const Methods = {
         return this.handleAsyncTreeExpandChilds(row)
       }).then(() => {
         if (transform) {
-          return this.updateVirtualTreeData()
+          return this.handleTableData()
         }
       }).then(() => {
         return this.recalculate()
@@ -3756,7 +3887,7 @@ const Methods = {
   },
   handleAsyncTreeExpandChilds (row) {
     const { fullAllDataRowMap, treeExpandeds, treeOpts, treeLazyLoadeds, checkboxOpts } = this
-    const { loadMethod } = treeOpts
+    const { transform, loadMethod } = treeOpts
     const { checkStrictly } = checkboxOpts
     const rest = fullAllDataRowMap.get(row)
     return new Promise(resolve => {
@@ -3776,9 +3907,17 @@ const Methods = {
             if (!checkStrictly && this.isCheckedByCheckboxRow(row)) {
               this.setCheckboxRow(childRows, true)
             }
+            this.$nextTick().then(() => {
+              if (transform) {
+                return this.handleTableData()
+              }
+            }).then(() => {
+              return this.recalculate()
+            }).then(() => resolve())
           })
+        } else {
+          this.$nextTick().then(() => this.recalculate()).then(() => resolve())
         }
-        resolve(this.$nextTick().then(this.recalculate))
       })
     })
   },
@@ -3842,23 +3981,6 @@ const Methods = {
     }
     return Promise.all(result).then(this.recalculate)
   },
-  updateVirtualTreeData () {
-    const { scrollYLoad: oldScrollYLoad, treeExpandeds, treeOpts, treeFullData } = this
-    const fullData = []
-    const expandMaps = new Map()
-    XEUtils.eachTree(treeFullData, (row, index, items, path, parent) => {
-      if (!parent || (expandMaps.has(parent) && treeExpandeds.indexOf(parent) > -1)) {
-        expandMaps.set(row, 1)
-        fullData.push(row)
-      }
-    }, treeOpts)
-    const scrollYLoad = this.updateScrollYStatus(fullData)
-    this.tableFullData = scrollYLoad ? fullData : treeFullData
-    if (scrollYLoad || oldScrollYLoad !== scrollYLoad) {
-      return this.handleTableData(true).then(() => this.recalculate())
-    }
-    return this.$nextTick()
-  },
   /**
    * 虚拟树的展开与收起
    * @param rows
@@ -3867,7 +3989,7 @@ const Methods = {
    */
   handleVirtualTreeExpand (rows, expanded) {
     return this.handleBaseTreeExpand(rows, expanded).then(() => {
-      return this.updateVirtualTreeData()
+      return this.handleTableData()
     }).then(() => {
       return this.recalculate()
     })
@@ -3915,7 +4037,7 @@ const Methods = {
     if (reserve) {
       XEUtils.eachTree(tableFullData, row => this.handleTreeExpandReserve(row, false), treeOpts)
     }
-    return this.updateVirtualTreeData().then(() => {
+    return this.handleTableData().then(() => {
       if (isExists) {
         this.recalculate()
       }
@@ -4424,7 +4546,7 @@ const Methods = {
 }
 
 // Module methods
-const funcs = 'setFilter,clearFilter,getCheckedFilters,closeMenu,setActiveCellArea,getActiveCellArea,getCellAreas,clearCellAreas,copyCellArea,cutCellArea,pasteCellArea,getCopyCellArea,clearCopyCellArea,setCellAreas,openFind,openReplace,getSelectedCell,clearSelected,insert,insertAt,remove,removeCheckboxRow,removeRadioRow,removeCurrentRow,getRecordset,getInsertRecords,getRemoveRecords,getUpdateRecords,clearActived,getActiveRecord,isActiveByRow,setActiveRow,setActiveCell,setSelectCell,clearValidate,fullValidate,validate,openExport,openPrint,exportData,openImport,importData,saveFile,readFile,importByFile,print'.split(',')
+const funcs = 'setFilter,openFilter,clearFilter,getCheckedFilters,closeMenu,setActiveCellArea,getActiveCellArea,getCellAreas,clearCellAreas,copyCellArea,cutCellArea,pasteCellArea,getCopyCellArea,clearCopyCellArea,setCellAreas,openFind,openReplace,getSelectedCell,clearSelected,insert,insertAt,remove,removeCheckboxRow,removeRadioRow,removeCurrentRow,getRecordset,getInsertRecords,getRemoveRecords,getUpdateRecords,clearActived,getActiveRecord,isActiveByRow,setActiveRow,setActiveCell,setSelectCell,clearValidate,fullValidate,validate,openExport,openPrint,exportData,openImport,importData,saveFile,readFile,importByFile,print'.split(',')
 
 funcs.forEach(name => {
   Methods[name] = function (...args) {

package/packages/table/src/util.js

@@ -20,6 +20,10 @@ export function restoreScrollLocation (_vm, scrollLeft, scrollTop) {
   })
 }
 
+export function toTreePathSeq (path) {
+  return path.map((num, i) => i % 2 === 0 ? (Number(num) + 1) : '.').join('')
+}
+
 export function removeScrollListener (scrollElem) {
   if (scrollElem && scrollElem._onscroll) {
     scrollElem.onscroll = null

package/packages/tools/src/dom.js

@@ -204,14 +204,9 @@ export const DomTools = {
     }
   },
   triggerEvent (targetElem, type) {
-    let evnt
-    if (typeof Event === 'function') {
-      evnt = new Event(type)
-    } else {
-      evnt = document.createEvent('Event')
-      evnt.initEvent(type, true, true)
+    if (targetElem) {
+      targetElem.dispatchEvent(new Event(type))
     }
-    targetElem.dispatchEvent(evnt)
   },
   calcHeight ($xetable, key) {
     const val = $xetable[key]

package/packages/tools/src/utils.js

@@ -183,7 +183,7 @@ export const UtilTools = {
   },
   // 行主键 key
   getRowkey ($xetable) {
-    return $xetable.rowId || '_XID'
+    return $xetable.rowId || '_X_ID'
   },
   // 行主键 value
   getRowid ($xetable, row) {

package/packages/v-x-e-table/src/conf.js

@@ -49,7 +49,7 @@ export default {
     //  storage: false,
     //  checkMethod () {}
     // },
-    // rowId: '_XID', // 行数据的唯一主键字段名
+    // rowId: '_X_ID', // 行数据的唯一主键字段名
     sortConfig: {
       // remote: false,
       // trigger: 'default',
@@ -67,6 +67,7 @@ export default {
       parentField: 'parentId',
       children: 'children',
       hasChild: 'hasChild',
+      mapChildren: '_X_CHILD',
       indent: 20,
       showIcon: true
     },

package/packages/validator/src/mixin.js

@@ -151,7 +151,7 @@ export default {
           const ruleProps = Object.keys(validRest)
           return this.$nextTick().then(() => {
             if (ruleProps.length) {
-              return validRest[ruleProps[0]][0]
+              return Promise.reject(validRest[ruleProps[0]][0])
             }
             if (cb) {
               cb()

package/types/table.d.ts

@@ -272,6 +272,7 @@ export declare class Table extends VXETableComponent {
   /**
    * 同步 data 数据；如果用了该方法，那么组件将不再记录增删改的状态，只能自行实现对应逻辑
    * 对于某些特殊的场景，比如深层树节点元素发生变动时可能会用到
+   * @deprecated
    */
   syncData(): Promise<any>;
   /**