vxe-pc-ui 4.4.20 → 4.4.22

package/types/components/table.d.ts

@@ -1,7 +1,7 @@
 import { RenderFunction, SetupContext, Ref, ComputedRef, ComponentPublicInstance, VNode } from 'vue'
 import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentBaseOptions, VxeComponentEventParams, VxeComponentSizeType, ValueOf, VxeGlobalConfig, VxeComponentStyleType, VxeComponentSlotType, VxeComponentAlignType } from '@vxe-ui/core'
 import { VxeColumnPropTypes, VxeColumnProps, VxeColumnSlotTypes } from './column'
-import { VxeTableProDefines, VxeTableProEmits } from './table-plugins'
+import { VxeTableExtendCellAreaDefines, VxeTableExtendCellAreaEmits } from './table-plugins'
 import { VxeGridConstructor } from './grid'
 import { VxeTooltipInstance, VxeTooltipPropTypes } from './tooltip'
 import { VxeModalPropTypes } from './modal'
@@ -24,7 +24,12 @@ export interface VxeTableConstructor<D = any> extends VxeComponentBaseOptions, V
   getComputeMaps(): TablePrivateComputed
   renderVN: RenderFunction
 
-  xegrid: VxeGridConstructor<D> | null
+  xeGrid: VxeGridConstructor<D> | null
+
+  /**
+   * @deprecated
+   */
+  xegrid: VxeGridConstructor<D> | null | undefined
 }
 
 export interface TablePrivateRef {
@@ -915,6 +920,13 @@ export namespace VxeTablePropTypes {
       row: D
       column: VxeTableDefines.ColumnInfo<D>
     }) => any
+    /**
+     * 是否精确筛选到每一行，默认情况下是父级被匹配到则所有子级也被匹配；如果传 true 则会对每一行进行筛选
+     */
+    isEvery?: boolean
+    /**
+     * 是否启用远程筛选
+     */
     remote?: boolean
     /**
      * 是否显示筛选按钮图标
@@ -1371,12 +1383,12 @@ export namespace VxeTablePropTypes {
      * 只对 mouse-config.extension 启用后有效，扩展区域之前的方法，可以通过返回 false 阻止扩展行为
      * @param params
      */
-    beforeExtendMethod?(params: VxeTableProDefines.CellAreaExtensionStartParams<D>): boolean
+    beforeExtendMethod?(params: VxeTableExtendCellAreaDefines.CellAreaExtensionStartParams<D>): boolean
     /**
      * 只对 mouse-config.extension 启用后有效，扩展区域之后的方法
      * @param params
      */
-    afterExtendMethod?(params: VxeTableProDefines.CellAreaExtensionEndParams<D>): void
+    afterExtendMethod?(params: VxeTableExtendCellAreaDefines.CellAreaExtensionEndParams<D>): void
     /**
      * 当点击表格之外，是否自动清除单元格的选取状态
      */
@@ -1385,7 +1397,7 @@ export namespace VxeTablePropTypes {
      * 只对 extendByCalc 启用后有效，重写单元格扩展区域计算值的方法
      * @param params
      */
-    extendCalcMethod?(params: VxeTableProDefines.ExtendCellAreaCalcBaseParams<D>): any[][]
+    extendCalcMethod?(params: VxeTableExtendCellAreaDefines.ExtendCellAreaCalcBaseParams<D>): any[][]
     /**
      * 只对 extendByCopy | extendByCalc 启用后有效，重写单元格扩展区域赋值的方法
      * @param params
@@ -1394,19 +1406,19 @@ export namespace VxeTablePropTypes {
       cellValue: any
       row: D
       column: VxeTableDefines.ColumnInfo<D>
-    } & VxeTableProDefines.ExtendCellAreaCalcBaseParams<D>): void
+    } & VxeTableExtendCellAreaDefines.ExtendCellAreaCalcBaseParams<D>): void
     /**
      * 只对 extendByCopy | extendByCalc 启用后有效，自定义单元格扩展区域赋值之前的方法，可以通过返回 false 阻止扩展赋值行为
      * @param params
      */
-    beforeExtendSetMethod?(params: VxeTableProDefines.ExtendCellAreaCalcBaseParams<D>): boolean
+    beforeExtendSetMethod?(params: VxeTableExtendCellAreaDefines.ExtendCellAreaCalcBaseParams<D>): boolean
     /**
      * 只对 extendByCopy | extendByCalc 启用后有效，自定义单元格扩展区域赋值之后的方法
      * @param params
      */
     afterExtendSetMethod?(params: {
       extendValues: any[][]
-    } & VxeTableProDefines.ExtendCellAreaCalcBaseParams<D>): void
+    } & VxeTableExtendCellAreaDefines.ExtendCellAreaCalcBaseParams<D>): void
   }
   export interface AreaOpts<D = any> extends AreaConfig<D> { }
 
@@ -1598,8 +1610,8 @@ export namespace VxeTablePropTypes {
      */
     beforeCopyMethod?(params: {
       isCut: boolean
-      activeArea: VxeTableProDefines.MouseActiveCellArea
-      targetAreas: VxeTableProDefines.CellAreaParams<DT>[]
+      activeArea: VxeTableExtendCellAreaDefines.MouseActiveCellArea
+      targetAreas: VxeTableExtendCellAreaDefines.CellAreaParams<DT>[]
       $table: VxeTableConstructor<DT> & VxeTablePrivateMethods<DT>
       $grid: VxeGridConstructor<DT> | null | undefined
     }): boolean
@@ -1608,7 +1620,7 @@ export namespace VxeTablePropTypes {
      */
     afterCopyMethod?(params: {
       isCut: boolean
-      targetAreas: VxeTableProDefines.CellAreaParams<DT>[]
+      targetAreas: VxeTableExtendCellAreaDefines.CellAreaParams<DT>[]
       $table: VxeTableConstructor<DT> & VxeTablePrivateMethods<DT>
       $grid: VxeGridConstructor<DT> | null | undefined
     }): boolean
@@ -1630,9 +1642,9 @@ export namespace VxeTablePropTypes {
      * 自定义单元格剪贴值清除之前的方法，可以通过返回 false 阻止清除行为
      */
     beforeCutMethod?:(params: {
-      activeArea: VxeTableProDefines.MouseActiveCellArea
-      cutAreas: VxeTableProDefines.CellAreaParams<DT>[]
-      currentAreas: VxeTableProDefines.CellAreaParams<DT>[]
+      activeArea: VxeTableExtendCellAreaDefines.MouseActiveCellArea
+      cutAreas: VxeTableExtendCellAreaDefines.CellAreaParams<DT>[]
+      currentAreas: VxeTableExtendCellAreaDefines.CellAreaParams<DT>[]
       clipData: {
         text?: string
         html?: string
@@ -1644,8 +1656,8 @@ export namespace VxeTablePropTypes {
      * 自定义单元格剪贴值清除之后的方法
      */
     afterCutMethod?:(params: {
-      cutAreas: VxeTableProDefines.CellAreaParams<DT>[]
-      currentAreas: VxeTableProDefines.CellAreaParams<DT>[]
+      cutAreas: VxeTableExtendCellAreaDefines.CellAreaParams<DT>[]
+      currentAreas: VxeTableExtendCellAreaDefines.CellAreaParams<DT>[]
       $table: VxeTableConstructor<DT> & VxeTablePrivateMethods<DT>
       $grid: VxeGridConstructor<DT> | null | undefined
     }) => void
@@ -1669,10 +1681,10 @@ export namespace VxeTablePropTypes {
      */
     beforePasteMethod?(params: {
       isCut: boolean
-      activeArea: VxeTableProDefines.MouseActiveCellArea
-      cutAreas: VxeTableProDefines.CellAreaParams<DT>[]
-      currentAreas: VxeTableProDefines.CellAreaParams<DT>[]
-      targetAreas: VxeTableProDefines.CellAreaParams<DT>[]
+      activeArea: VxeTableExtendCellAreaDefines.MouseActiveCellArea
+      cutAreas: VxeTableExtendCellAreaDefines.CellAreaParams<DT>[]
+      currentAreas: VxeTableExtendCellAreaDefines.CellAreaParams<DT>[]
+      targetAreas: VxeTableExtendCellAreaDefines.CellAreaParams<DT>[]
       cellValues: string[][]
       pasteCells: string[][]
       clipData: {
@@ -1687,9 +1699,9 @@ export namespace VxeTablePropTypes {
      */
     afterPasteMethod?(params: {
       isCut: boolean
-      currentAreas: VxeTableProDefines.CellAreaParams<DT>[]
-      cutAreas: VxeTableProDefines.CellAreaParams<DT>[]
-      targetAreas: VxeTableProDefines.CellAreaParams<DT>[]
+      currentAreas: VxeTableExtendCellAreaDefines.CellAreaParams<DT>[]
+      cutAreas: VxeTableExtendCellAreaDefines.CellAreaParams<DT>[]
+      targetAreas: VxeTableExtendCellAreaDefines.CellAreaParams<DT>[]
       cellValues: any[][]
       pasteCells: string[][]
       insertRows: DT[]
@@ -1701,8 +1713,8 @@ export namespace VxeTablePropTypes {
      * 只对 isRowIncrement 有效，自定义创建自增行数据的方法
      */
     createRowsMethod?(params: {
-      currentAreas: VxeTableProDefines.CellAreaParams<DT>[]
-      targetAreas: VxeTableProDefines.CellAreaParams<DT>[]
+      currentAreas: VxeTableExtendCellAreaDefines.CellAreaParams<DT>[]
+      targetAreas: VxeTableExtendCellAreaDefines.CellAreaParams<DT>[]
       cellValues: any[][]
       pasteCells: string[][]
       insertRows: DT[]
@@ -1713,8 +1725,8 @@ export namespace VxeTablePropTypes {
      * 只对 isColumnIncrement 有效，自定义创建自增列配置的方法
      */
     createColumnsMethod?(params: {
-      currentAreas: VxeTableProDefines.CellAreaParams<DT>[]
-      targetAreas: VxeTableProDefines.CellAreaParams<DT>[]
+      currentAreas: VxeTableExtendCellAreaDefines.CellAreaParams<DT>[]
+      targetAreas: VxeTableExtendCellAreaDefines.CellAreaParams<DT>[]
       cellValues: any[][]
       pasteCells: string[][]
       insertColumns: VxeTableDefines.ColumnOptions[]
@@ -1758,7 +1770,7 @@ export namespace VxeTablePropTypes {
     afterFindMethod?(params: {
       isAll: boolean
       findValue: string | null
-      result: VxeTableProDefines.FindAndReplaceResult[]
+      result: VxeTableExtendCellAreaDefines.FindAndReplaceResult[]
       $table: VxeTableConstructor<DT> & VxeTablePrivateMethods<DT>
       $grid: VxeGridConstructor<DT> | null | undefined
     }): void
@@ -1793,7 +1805,7 @@ export namespace VxeTablePropTypes {
       isAll: boolean
       findValue: string
       replaceValue: string
-      result: VxeTableProDefines.FindAndReplaceResult[]
+      result: VxeTableExtendCellAreaDefines.FindAndReplaceResult[]
       $table: VxeTableConstructor<DT> & VxeTablePrivateMethods<DT>
       $grid: VxeGridConstructor<DT> | null | undefined
     }) => void
@@ -4429,7 +4441,7 @@ export type VxeTableEmits = [
   'scroll-boundary',
   'custom',
 
-  ...VxeTableProEmits
+  ...VxeTableExtendCellAreaEmits
 ]
 
 export namespace VxeTableDefines {
@@ -4911,8 +4923,8 @@ export namespace VxeTableDefines {
     rowIndex: number
     column: VxeTableDefines.ColumnInfo<D>
     columnIndex: number
-    activeArea: VxeTableProDefines.MouseActiveCellArea<D>
-    cellAreas: VxeTableProDefines.MouseCellArea<D>[]
+    activeArea: VxeTableExtendCellAreaDefines.MouseActiveCellArea<D>
+    cellAreas: VxeTableExtendCellAreaDefines.MouseCellArea<D>[]
    }
   export interface CellDeleteValueEventParams<D = any> extends TableEventParams<D>, CellDeleteValueParams<D> { }