Emits 事件

API

sort-change

排序变更触发。defaultSort.dataIndex 找不到时，col 将返回 null。

(e: 'sort-change', col: StkTableColumn<DT> | null, order: Order, data: DT[], sortConfig: SortConfig<DT>): void;

参数	说明
col	排序的列
order	排序方向
data	表格当前工作数据（经过排序和筛选后的内部副本），不是原始 props.dataSource。如果当前有激活的筛选，data 仅包含过滤后的行。在 sort-remote 场景中，应基于原始数据源排序后回传，而非直接将 data 赋值给 dataSource
sortConfig	排序配置

row-click

一行点击事件。

(e: 'row-click', ev: MouseEvent, row: DT, data: { rowIndex: number }): void;

current-change

选中一行触发。ev 返回 null 表示不是点击事件触发的。

(e: 'current-change', ev: MouseEvent | null, row: DT | undefined, data: { select: boolean }): void;

cell-selected

选中单元格触发。ev 返回 null 表示不是点击事件触发的。

(e: 'cell-selected', ev: MouseEvent | null, data: { select: boolean; row: DT | undefined; col: StkTableColumn<DT> | undefined }): void;

row-dblclick

行双击事件。

(e: 'row-dblclick', ev: MouseEvent, row: DT, data: { rowIndex: number }): void;

header-row-menu

表头右键事件。

(e: 'header-row-menu', ev: MouseEvent): void;

row-menu

表体行右键点击事件。

(e: 'row-menu', ev: MouseEvent, row: DT, data: { rowIndex: number }): void;

cell-click

单元格点击事件。

(e: 'cell-click', ev: MouseEvent, row: DT, col: StkTableColumn<DT>, data: { rowIndex: number }): void;

cell-mouseenter

单元格鼠标进入事件。

(e: 'cell-mouseenter', ev: MouseEvent, row: DT, col: StkTableColumn<DT>): void;

cell-mouseleave

单元格鼠标移出事件。

(e: 'cell-mouseleave', ev: MouseEvent, row: DT, col: StkTableColumn<DT>): void;

cell-mouseover

单元格悬浮事件。

(e: 'cell-mouseover', ev: MouseEvent, row: DT, col: StkTableColumn<DT>): void;

cell-mousedown

单元格鼠标按下事件。

(e: 'cell-mousedown', ev: MouseEvent, row: DT, col: StkTableColumn<DT>, data: { rowIndex: number }): void;

header-cell-click

表头单元格点击事件。

(e: 'header-cell-click', ev: MouseEvent, col: StkTableColumn<DT>): void;

scroll

表格滚动事件。

(e: 'scroll', ev: Event, data: { startIndex: number; endIndex: number }): void;

scroll-x

表格横向滚动事件。

(e: 'scroll-x', ev: Event): void;

col-order-change

表头列拖动事件。

(e: 'col-order-change', dragStartKey: string, targetColKey: string): void;

th-drag-start

表头列拖动开始。

(e: 'th-drag-start', dragStartKey: string): void;

th-drop

表头列拖动 drop。

(e: 'th-drop', targetColKey: string): void;

row-order-change

行拖动事件。

(e: 'row-order-change', dragStartKey: string, targetRowKey: string): void;

col-resize

列宽变动时触发。

(e: 'col-resize', col: StkTableColumn<DT>): void;

filter-change

筛选状态变更时触发。通过调用 setFilter 方法设置筛选状态时才会触发此回调。

(e: 'filter-change', status: Record<UniqKey, FilterStatus>): void;

toggle-row-expand

展开行触发。

(e: 'toggle-row-expand', data: { expanded: boolean; row: DT; col: StkTableColumn<DT> | null }): void;

toggle-tree-expand

点击展开树行触发。

(e: 'toggle-tree-expand', data: { expanded: boolean; row: DT; col: StkTableColumn<DT> | null }): void;

懒加载下（treeConfig.lazy = true）

展开未加载分支时，事件在 loadMethod 成功 resolve 并并入子节点后才触发；取数失败（reject）不会触发该事件。收起与已缓存节点的展开仍同步触发。

area-selection-change

单元格选区变更事件。

(e: 'area-selection-change', ranges: AreaSelectionRange[]): void;

AreaSelectionRange

单元格选区范围类型。每个选区通过 index 字段描述在表格中覆盖的单元格范围。

type AreaSelectionRange = {
    index: {
        /** 列索引范围 [起始列, 结束列]（包含两端） @deprecated 请使用 begin/end */
        x: [number, number];
        /** 行索引范围 [起始行, 结束行]（包含两端） @deprecated 请使用 begin/end */
        y: [number, number];
        /** 选区起始点索引 */
        begin: { row: number; col: number };
        /** 选区结束点索引 */
        end: { row: number; col: number };
    };
};

字段	类型	说明
index.x	[number, number]	选区覆盖的列索引范围，[起始列, 结束列]，包含两端。已废弃，请使用 begin/end
index.y	[number, number]	选区覆盖的行索引范围，[起始行, 结束行]，包含两端。已废弃，请使用 begin/end
index.begin	{ row: number; col: number }	选区起始点索引
index.end	{ row: number; col: number }	选区结束点索引

当使用 Ctrl 多选或 Shift 扩选时，ranges 可能包含多个选区。

update:columns

v-model:columns col resize 时更新宽度。

(e: 'update:columns', cols: StkTableColumn<DT>[]): void;