Class: AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE> ​

适配 Ant Design Vue 的 TableHelper.

Type parameters ​

Hierarchy ​

• TableHelper<RECORD_KEY, RECORD_TYPE>

  ↳ AntDesignVueTableHelper

Constructors ​

constructor ​

new AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>(loadRecord, recordKeyName, options?)

Type parameters ​

Parameters ​

Overrides ​

TableHelper.constructor

Defined in ​

dist/src/components/n-table/ant-design-vue-table-helper.d.ts:7

Properties ​

antdvOptions ​

antdvOptions: AntDesignVueTableHelperOptions

Defined in ​

dist/src/components/n-table/ant-design-vue-table-helper.d.ts:9

filterParams ​

filterParams: TableFilterParams

Inherited from ​

TableHelper.filterParams

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:46

loading ​

loading: boolean

指示当前是否正在加载数据的流程中

Inherited from ​

TableHelper.loading

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:51

options ​

Readonly options: TableHelperOptions

Inherited from ​

TableHelper.options

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:44

paginationParams ​

paginationParams: TablePaginationParams

Inherited from ​

TableHelper.paginationParams

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:45

processing ​

processing: boolean

指示当前是否正在任何流程中, 包括加载中以及加载前后.

See

_loadRecord

Inherited from ​

TableHelper.processing

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:57

sortParams ​

sortParams: TableSortParams[]

Inherited from ​

TableHelper.sortParams

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:47

total ​

total: number

数据总条数

Inherited from ​

TableHelper.total

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:61

Accessors ​

antdvPaginationParams ​

get antdvPaginationParams(): false | AntDesignVueTablePaginationParams

用于 TableProps.pagination 属性.

因为 TablePaginationParams 无法满足 Ant Design Vue 的分页参数, 所以需要额外的分页参数.

Returns ​

false | AntDesignVueTablePaginationParams

Defined in ​

dist/src/components/n-table/ant-design-vue-table-helper.d.ts:23

dataSource ​

get dataSource(): RECORD_TYPE[]

用于 TableProps.dataSource 属性.

Returns ​

RECORD_TYPE[]

Defined in ​

dist/src/components/n-table/ant-design-vue-table-helper.d.ts:17

pageCount ​

get pageCount(): number

根据 paginationParams.pageSize 和 total 计算出的总页数, 以便于分页时使用.

该值为绝对页数, 不会受到 options.pageStartIndex 的影响.

Returns ​

number

Inherited from ​

TableHelper.TableHelper.pageCount

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:71

records ​

get records(): RECORD_TYPE[]

获取最新加载的数据

Returns ​

RECORD_TYPE[]

Inherited from ​

TableHelper.TableHelper.records

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:65

rowKey ​

get rowKey(): RECORD_KEY

用于 TableProps.rowKey 属性.

Returns ​

RECORD_KEY

Defined in ​

dist/src/components/n-table/ant-design-vue-table-helper.d.ts:13

Methods ​

addSortParams ​

addSortParams(...paramsList): AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

设置排序参数, 并重新加载数据.

Parameters ​

Returns ​

AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

Inherited from ​

TableHelper.addSortParams

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:113

clearDataSource ​

clearDataSource(): void

清除最新加载的记录

Returns ​

void

Defined in ​

dist/src/components/n-table/ant-design-vue-table-helper.d.ts:27

destroy ​

destroy(): void

Returns ​

void

Inherited from ​

TableHelper.destroy

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:139

firstPage ​

firstPage(): AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

加载第一页的数据, 如果当前已经是第一页则被忽略.

Returns ​

AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

Inherited from ​

TableHelper.firstPage

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:87

lastPage ​

lastPage(): AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

加载最后一页的数据, 如果当前已经是最后一页则被忽略.

Returns ​

AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

Inherited from ​

TableHelper.lastPage

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:79

loadRecord ​

loadRecord(immediate?): AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

重新加载数据, 默认会有 480 ms 的防抖. 如需要立即加载, 将 immediate 设置为 true, 则会忽略防抖并立即加载数据.

Parameters ​

Returns ​

AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

Inherited from ​

TableHelper.loadRecord

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:138

nextPage ​

nextPage(): AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

加载下一页的数据, 已到达最后一页时被忽略.

Returns ​

AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

Inherited from ​

TableHelper.nextPage

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:75

off ​

off<K>(type, listener): void

Type parameters ​

Parameters ​

Returns ​

void

Inherited from ​

TableHelper.off

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:141

on ​

on<K>(type, listener): void

Type parameters ​

Parameters ​

Returns ​

void

Inherited from ​

TableHelper.on

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:140

once ​

once<K>(type, listener): void

Type parameters ​

Parameters ​

Returns ​

void

Inherited from ​

TableHelper.once

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:142

previousPage ​

previousPage(): AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

加载上一页的数据, 已到达第一页时被忽略.

Returns ​

AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

Inherited from ​

TableHelper.previousPage

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:83

reloadPage ​

reloadPage(): AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

重新请求当前页的数据.

Returns ​

AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

Inherited from ​

TableHelper.reloadPage

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:91

removeSortParams ​

removeSortParams(...args): AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

移除排序参数, 并重新加载数据.

Parameters ​

Returns ​

AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

Inherited from ​

TableHelper.removeSortParams

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:118

skipToPage ​

skipToPage(pageNumber, relative?): AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

跳转到指定页码. 页码默认是相对与 pageStartIndex 的, 可以设置 relative 为 false 使用绝对页码.

Parameters ​

Returns ​

AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

Inherited from ​

TableHelper.skipToPage

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:97

updateFilterParams ​

updateFilterParams(params): AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

设置过滤参数, 并重新加载数据.

Parameters ​

Returns ​

AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

Inherited from ​

TableHelper.updateFilterParams

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:108

updatePaginationParams ​

updatePaginationParams(params): AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

设置分页参数, 并重新加载数据.

Parameters ​

Returns ​

AntDesignVueTableHelper<RECORD_KEY, RECORD_TYPE>

Inherited from ​

TableHelper.updatePaginationParams

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:124

wait ​

wait(): Promise<void>

等待记录加载完成.

注意: 如果当前没有在加载数据, 会等待直到下一次加载数据完成.

Returns ​

Promise<void>

Inherited from ​

TableHelper.wait

Defined in ​

dist/src/components/table-helper/table-helper.d.ts:103