Class: TableHelper<RECORD_KEY, RECORD_TYPE> ​

TableHelper.TableHelper

加载表格数据的函数

Type parameters ​

Hierarchy ​

• TableHelper

  ↳ AntDesignVueTableHelper

  ↳ AutoLoadSelectHelper

Constructors ​

constructor ​

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

Type parameters ​

Parameters ​

Defined in ​

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

Properties ​

filterParams ​

filterParams: TableFilterParams

Defined in ​

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

loading ​

loading: boolean

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

Defined in ​

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

options ​

Readonly options: TableHelperOptions

Defined in ​

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

paginationParams ​

paginationParams: TablePaginationParams

Defined in ​

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

processing ​

processing: boolean

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

See

_loadRecord

Defined in ​

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

sortParams ​

sortParams: TableSortParams[]

Defined in ​

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

total ​

total: number

数据总条数

Defined in ​

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

Accessors ​

pageCount ​

get pageCount(): number

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

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

Returns ​

number

Defined in ​

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

records ​

get records(): RECORD_TYPE[]

获取最新加载的数据

Returns ​

RECORD_TYPE[]

Defined in ​

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

Methods ​

addSortParams ​

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

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

Parameters ​

Returns ​

TableHelper<RECORD_KEY, RECORD_TYPE>

Defined in ​

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

destroy ​

destroy(): void

Returns ​

void

Defined in ​

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

firstPage ​

firstPage(): TableHelper<RECORD_KEY, RECORD_TYPE>

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

Returns ​

TableHelper<RECORD_KEY, RECORD_TYPE>

Defined in ​

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

lastPage ​

lastPage(): TableHelper<RECORD_KEY, RECORD_TYPE>

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

Returns ​

TableHelper<RECORD_KEY, RECORD_TYPE>

Defined in ​

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

loadRecord ​

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

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

Parameters ​

Returns ​

TableHelper<RECORD_KEY, RECORD_TYPE>

Defined in ​

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

nextPage ​

nextPage(): TableHelper<RECORD_KEY, RECORD_TYPE>

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

Returns ​

TableHelper<RECORD_KEY, RECORD_TYPE>

Defined in ​

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

off ​

off<K>(type, listener): void

Type parameters ​

Parameters ​

Returns ​

void

Defined in ​

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

on ​

on<K>(type, listener): void

Type parameters ​

Parameters ​

Returns ​

void

Defined in ​

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

once ​

once<K>(type, listener): void

Type parameters ​

Parameters ​

Returns ​

void

Defined in ​

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

previousPage ​

previousPage(): TableHelper<RECORD_KEY, RECORD_TYPE>

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

Returns ​

TableHelper<RECORD_KEY, RECORD_TYPE>

Defined in ​

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

reloadPage ​

reloadPage(): TableHelper<RECORD_KEY, RECORD_TYPE>

重新请求当前页的数据.

Returns ​

TableHelper<RECORD_KEY, RECORD_TYPE>

Defined in ​

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

removeSortParams ​

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

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

Parameters ​

Returns ​

TableHelper<RECORD_KEY, RECORD_TYPE>

Defined in ​

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

skipToPage ​

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

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

Parameters ​

Returns ​

TableHelper<RECORD_KEY, RECORD_TYPE>

Defined in ​

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

updateFilterParams ​

updateFilterParams(params): TableHelper<RECORD_KEY, RECORD_TYPE>

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

Parameters ​

Returns ​

TableHelper<RECORD_KEY, RECORD_TYPE>

Defined in ​

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

updatePaginationParams ​

updatePaginationParams(params): TableHelper<RECORD_KEY, RECORD_TYPE>

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

Parameters ​

Returns ​

TableHelper<RECORD_KEY, RECORD_TYPE>

Defined in ​

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

wait ​

wait(): Promise<void>

等待记录加载完成.

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

Returns ​

Promise<void>

Defined in ​

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