Skip to content
On this page

Interface: NTableRowSelection ​

Hierarchy ​

  • TableRowSelection

    ↳ NTableRowSelection

Properties ​

checkStrictly ​

Optional checkStrictly: boolean

Inherited from ​

TableRowSelection.checkStrictly

Defined in ​

node_modules/ant-design-vue/lib/table/interface.d.ts:128


columnTitle ​

Optional columnTitle: VueNode

Inherited from ​

TableRowSelection.columnTitle

Defined in ​

node_modules/ant-design-vue/lib/table/interface.d.ts:127


columnWidth ​

Optional columnWidth: string | number

Inherited from ​

TableRowSelection.columnWidth

Defined in ​

node_modules/ant-design-vue/lib/table/interface.d.ts:126


defaultSelectedRowKeys ​

Optional defaultSelectedRowKeys: Key[]

Inherited from ​

TableRowSelection.defaultSelectedRowKeys

Defined in ​

node_modules/ant-design-vue/lib/table/interface.d.ts:113


disabledRowKeys ​

disabledRowKeys: any[]

禁用的行的 key

Defined in ​

dist/src/components/n-table/table-types.d.ts:192


fixed ​

Optional fixed: FixedType

Inherited from ​

TableRowSelection.fixed

Defined in ​

node_modules/ant-design-vue/lib/table/interface.d.ts:125


getCheckboxProps ​

Optional getCheckboxProps: (record: any) => Partial<Omit<Partial<ExtractPropTypes<{ autofocus: { default: any ; type: BooleanConstructor } ; checked: { default: any ; type: BooleanConstructor } ; defaultChecked: { default: any ; type: BooleanConstructor } ; disabled: { default: any ; type: BooleanConstructor } ; id: StringConstructor ; indeterminate: { default: boolean ; type: BooleanConstructor } ; isGroup: { default: any ; type: BooleanConstructor } ; name: StringConstructor ; onChange: PropType<(e: CheckboxChangeEvent) => void> ; onClick: PropType<MouseEventHandler> ; onUpdate:checked: PropType<(checked: boolean) => void> ; prefixCls: StringConstructor ; skipGroup: { default: boolean ; type: BooleanConstructor } ; type: { default: string ; type: StringConstructor } ; value: VueTypeValidableDef<any> }>>, "checked" | "defaultChecked">>

Type declaration ​

(record): Partial<Omit<Partial<ExtractPropTypes<{ autofocus: { default: any ; type: BooleanConstructor } ; checked: { default: any ; type: BooleanConstructor } ; defaultChecked: { default: any ; type: BooleanConstructor } ; disabled: { default: any ; type: BooleanConstructor } ; id: StringConstructor ; indeterminate: { default: boolean ; type: BooleanConstructor } ; isGroup: { default: any ; type: BooleanConstructor } ; name: StringConstructor ; onChange: PropType<(e: CheckboxChangeEvent) => void> ; onClick: PropType<MouseEventHandler> ; onUpdate:checked: PropType<(checked: boolean) => void> ; prefixCls: StringConstructor ; skipGroup: { default: boolean ; type: BooleanConstructor } ; type: { default: string ; type: StringConstructor } ; value: VueTypeValidableDef<any> }>>, "checked" | "defaultChecked">>

Parameters ​
NameType
recordany
Returns ​

Partial<Omit<Partial<ExtractPropTypes<{ autofocus: { default: any ; type: BooleanConstructor } ; checked: { default: any ; type: BooleanConstructor } ; defaultChecked: { default: any ; type: BooleanConstructor } ; disabled: { default: any ; type: BooleanConstructor } ; id: StringConstructor ; indeterminate: { default: boolean ; type: BooleanConstructor } ; isGroup: { default: any ; type: BooleanConstructor } ; name: StringConstructor ; onChange: PropType<(e: CheckboxChangeEvent) => void> ; onClick: PropType<MouseEventHandler> ; onUpdate:checked: PropType<(checked: boolean) => void> ; prefixCls: StringConstructor ; skipGroup: { default: boolean ; type: BooleanConstructor } ; type: { default: string ; type: StringConstructor } ; value: VueTypeValidableDef<any> }>>, "checked" | "defaultChecked">>

Inherited from ​

TableRowSelection.getCheckboxProps

Defined in ​

node_modules/ant-design-vue/lib/table/interface.d.ts:115


hideSelectAll ​

Optional hideSelectAll: boolean

Inherited from ​

TableRowSelection.hideSelectAll

Defined in ​

node_modules/ant-design-vue/lib/table/interface.d.ts:124


isAllSelected ​

isAllSelected: (excludeDisabledRow?: boolean) => boolean

Type declaration ​

(excludeDisabledRow?): boolean

判断是否所有行都被选中. 如果 excludeDisabledRow 为 true, 被禁用的行不会被计算在内.

Parameters ​
NameTypeDescription
excludeDisabledRow?boolean是否排除被禁用的行. 默认为 false.
Returns ​

boolean

Defined in ​

dist/src/components/n-table/table-types.d.ts:223


isNoneSelected ​

isNoneSelected: () => boolean

Type declaration ​

(): boolean

被选中的行数是否为 0

Returns ​

boolean

Defined in ​

dist/src/components/n-table/table-types.d.ts:227


isSelected ​

isSelected: (data: RecordType) => boolean

Type declaration ​

(data): boolean

判断行是否被选中

Parameters ​
NameTypeDescription
dataRecordType行数据
Returns ​

boolean

Defined in ​

dist/src/components/n-table/table-types.d.ts:212


onChange ​

onChange: (selectedRowKeys: Key[], selectedRows: any[]) => void

Type declaration ​

(selectedRowKeys, selectedRows): void

选择行变化时的回调

Parameters ​
NameType
selectedRowKeysKey[]
selectedRowsany[]
Returns ​

void

Overrides ​

TableRowSelection.onChange

Defined in ​

dist/src/components/n-table/table-types.d.ts:196


onSelect ​

Optional onSelect: SelectionSelectFn<any>

Inherited from ​

TableRowSelection.onSelect

Defined in ​

node_modules/ant-design-vue/lib/table/interface.d.ts:116


onSelectAll ​

Optional onSelectAll: (selected: boolean, selectedRows: any[], changeRows: any[]) => void

Type declaration ​

(selected, selectedRows, changeRows): void

Deprecated

This function is meaningless and should use onChange instead

Parameters ​
NameType
selectedboolean
selectedRowsany[]
changeRowsany[]
Returns ​

void

Inherited from ​

TableRowSelection.onSelectAll

Defined in ​

node_modules/ant-design-vue/lib/table/interface.d.ts:119


onSelectInvert ​

Optional onSelectInvert: (selectedRowKeys: Key[]) => void

Type declaration ​

(selectedRowKeys): void

Deprecated

This function is meaningless and should use onChange instead

Parameters ​
NameType
selectedRowKeysKey[]
Returns ​

void

Inherited from ​

TableRowSelection.onSelectInvert

Defined in ​

node_modules/ant-design-vue/lib/table/interface.d.ts:121


onSelectMultiple ​

Optional onSelectMultiple: (selected: boolean, selectedRows: any[], changeRows: any[]) => void

Type declaration ​

(selected, selectedRows, changeRows): void

Parameters ​
NameType
selectedboolean
selectedRowsany[]
changeRowsany[]
Returns ​

void

Inherited from ​

TableRowSelection.onSelectMultiple

Defined in ​

node_modules/ant-design-vue/lib/table/interface.d.ts:117


onSelectNone ​

Optional onSelectNone: () => void

Type declaration ​

(): void

Returns ​

void

Inherited from ​

TableRowSelection.onSelectNone

Defined in ​

node_modules/ant-design-vue/lib/table/interface.d.ts:122


preserveSelectedRowKeys ​

Optional preserveSelectedRowKeys: boolean

Keep the selection keys in list even the key not exist in dataSource anymore

Inherited from ​

TableRowSelection.preserveSelectedRowKeys

Defined in ​

node_modules/ant-design-vue/lib/table/interface.d.ts:110


renderCell ​

Optional renderCell: (value: boolean, record: any, index: number, originNode: VueNode) => VueNode | RenderedCell<any>

Type declaration ​

(value, record, index, originNode): VueNode | RenderedCell<any>

Parameters ​
NameType
valueboolean
recordany
indexnumber
originNodeVueNode
Returns ​

VueNode | RenderedCell<any>

Inherited from ​

TableRowSelection.renderCell

Defined in ​

node_modules/ant-design-vue/lib/table/interface.d.ts:129


reset ​

reset: () => void

Type declaration ​

(): void

重置已选择行

Returns ​

void

Defined in ​

dist/src/components/n-table/table-types.d.ts:200


select ​

select: (data: RecordType, selected?: boolean, force?: boolean) => void

Type declaration ​

(data, selected?, force?): void

选择或取消选择行

Parameters ​
NameTypeDescription
dataRecordType行数据
selected?boolean是否选中
force?boolean是否包括被禁用的行
Returns ​

void

Defined in ​

dist/src/components/n-table/table-types.d.ts:207


selectAll ​

selectAll: (selected?: boolean, force?: boolean) => void

Type declaration ​

(selected?, force?): void

选择或取消选择所有行

Parameters ​
NameTypeDescription
selected?boolean是否选中
force?boolean是否包括被禁用的行
Returns ​

void

Defined in ​

dist/src/components/n-table/table-types.d.ts:218


selectedRowKeys ​

selectedRowKeys: any[]

已选择行的 key

Overrides ​

TableRowSelection.selectedRowKeys

Defined in ​

dist/src/components/n-table/table-types.d.ts:184


selectedRows ​

selectedRows: RecordType[]

已选择行的数据

Defined in ​

dist/src/components/n-table/table-types.d.ts:188


selections ​

Optional selections: boolean | INTERNAL_SELECTION_ITEM[]

Inherited from ​

TableRowSelection.selections

Defined in ​

node_modules/ant-design-vue/lib/table/interface.d.ts:123


type ​

Optional type: RowSelectionType

Inherited from ​

TableRowSelection.type

Defined in ​

node_modules/ant-design-vue/lib/table/interface.d.ts:111